Skip to content

OnPremiseConfiguration

Source code in docs_src/capo_kendra/types/on_premise_configuration.py 
15
16
17
18
19
20
21
class OnPremiseConfiguration(TypedDict, closed=True):
    host_url: "capo_kendra.types.url.Url"
    """<p>The GitHub host URL or API endpoint URL. For example, <i>https://on-prem-host-url/api/v3/</i> </p>"""
    organization_name: "capo_kendra.types.organization_name.OrganizationName"
    """<p>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 <b>Your organizations</b> under your profile picture dropdown.</p>"""
    ssl_certificate_s3_path: "capo_kendra.types.s3_path.S3Path"
    """<p>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.</p> <p>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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign an X509 certificate</a>.</p>"""

host_url instance-attribute 

host_url: Url

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

organization_name instance-attribute 

organization_name: 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.

ssl_certificate_s3_path instance-attribute 

ssl_certificate_s3_path: 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.