Class: Aws::Kendra::Types::OnPremiseConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#host_url ⇒ String

The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

Returns:

  • (String) 


7527
7528
7529
7530
7531
7532
7533
 
# File 'lib/aws-sdk-kendra/types.rb', line 7527

class OnPremiseConfiguration < Struct.new(
  :host_url,
  :organization_name,
  :ssl_certificate_s3_path)
  SENSITIVE = []
  include Aws::Structure
end

#organization_name ⇒ String

The name of the organization of the GitHub Enterprise Server (on-premises) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting **Your organizations** under your profile picture dropdown.

Returns:

  • (String) 


7527
7528
7529
7530
7531
7532
7533
 
# File 'lib/aws-sdk-kendra/types.rb', line 7527

class OnPremiseConfiguration < Struct.new(
  :host_url,
  :organization_name,
  :ssl_certificate_s3_path)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_certificate_s3_path ⇒ Types::S3Path

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see [Create and sign an X509 certificate].

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html

Returns:



7527
7528
7529
7530
7531
7532
7533
 
# File 'lib/aws-sdk-kendra/types.rb', line 7527

class OnPremiseConfiguration < Struct.new(
  :host_url,
  :organization_name,
  :ssl_certificate_s3_path)
  SENSITIVE = []
  include Aws::Structure
end