Amazonka.Kendra.Types.OnPremiseConfiguration

Documentation

data OnPremiseConfiguration

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

See: newOnPremiseConfiguration smart constructor.

Constructors

OnPremiseConfiguration'

Fields

• hostUrl :: Text

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

• organizationName :: Text

  The name of the organization of the GitHub Enterprise Server (in-premise) 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.

• sslCertificateS3Path :: 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.

Instances

FromJSON OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

parseJSON :: Value -> Parser OnPremiseConfiguration

parseJSONList :: Value -> Parser [OnPremiseConfiguration]

ToJSON OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

toJSON :: OnPremiseConfiguration -> Value

toEncoding :: OnPremiseConfiguration -> Encoding

toJSONList :: [OnPremiseConfiguration] -> Value

toEncodingList :: [OnPremiseConfiguration] -> Encoding

Generic OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Associated Types

type Rep OnPremiseConfiguration :: Type -> Type

Methods

from :: OnPremiseConfiguration -> Rep OnPremiseConfiguration x

to :: Rep OnPremiseConfiguration x -> OnPremiseConfiguration

Read OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

readsPrec :: Int -> ReadS OnPremiseConfiguration

readList :: ReadS [OnPremiseConfiguration]

readPrec :: ReadPrec OnPremiseConfiguration

readListPrec :: ReadPrec [OnPremiseConfiguration]

Show OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

showsPrec :: Int -> OnPremiseConfiguration -> ShowS

show :: OnPremiseConfiguration -> String

showList :: [OnPremiseConfiguration] -> ShowS

NFData OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

rnf :: OnPremiseConfiguration -> ()

Eq OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

(==) :: OnPremiseConfiguration -> OnPremiseConfiguration -> Bool

(/=) :: OnPremiseConfiguration -> OnPremiseConfiguration -> Bool

Hashable OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

hashWithSalt :: Int -> OnPremiseConfiguration -> Int

hash :: OnPremiseConfiguration -> Int

type Rep OnPremiseConfiguration

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

type Rep OnPremiseConfiguration = D1 ('MetaData "OnPremiseConfiguration" "Amazonka.Kendra.Types.OnPremiseConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OnPremiseConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "organizationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path))))

newOnPremiseConfiguration

Arguments

:: Text

$sel:hostUrl:OnPremiseConfiguration'

-> Text

$sel:organizationName:OnPremiseConfiguration'

-> S3Path

$sel:sslCertificateS3Path:OnPremiseConfiguration'

-> OnPremiseConfiguration

Create a value of OnPremiseConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hostUrl:OnPremiseConfiguration', onPremiseConfiguration_hostUrl - The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

$sel:organizationName:OnPremiseConfiguration', onPremiseConfiguration_organizationName - The name of the organization of the GitHub Enterprise Server (in-premise) 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.

$sel:sslCertificateS3Path:OnPremiseConfiguration', onPremiseConfiguration_sslCertificateS3Path - 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.

onPremiseConfiguration_hostUrl :: Lens' OnPremiseConfiguration Text

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

onPremiseConfiguration_organizationName :: Lens' OnPremiseConfiguration Text

The name of the organization of the GitHub Enterprise Server (in-premise) 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.

onPremiseConfiguration_sslCertificateS3Path :: Lens' OnPremiseConfiguration 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.