OnPremiseConfiguration
Provides the configuration information to connect to GitHub Enterprise Server (on premises).
Contents
- HostUrl
-
The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(https?|ftp|file):\/\/([^\s]*)Required: Yes
- OrganizationName
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Pattern:
^[A-Za-z0-9_.-]+$Required: Yes
- 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.
Type: S3Path object
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
