create_host¶

create_host(**kwargs)¶

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

Note

A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

See also: AWS API Documentation

Request Syntax

response = client.create_host(
    Name='string',
    ProviderType='Bitbucket'|'GitHub'|'GitHubEnterpriseServer',
    ProviderEndpoint='string',
    VpcConfiguration={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

Name (string) --
[REQUIRED]

The name of the host to be created. The name must be unique in the calling AWS account.
ProviderType (string) --
[REQUIRED]

The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
ProviderEndpoint (string) --
[REQUIRED]

The endpoint of the infrastructure to be represented by the host after it is created.
VpcConfiguration (dict) --
The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.
- VpcId (string) -- [REQUIRED]
  The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
- SubnetIds (list) -- [REQUIRED]
  The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
  - (string) --
- SecurityGroupIds (list) -- [REQUIRED]
  The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
  - (string) --
- TlsCertificate (string) --
  The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.
Tags (list) --
- (dict) --
  A tag is a key-value pair that is used to manage the resource.
  
  This tag is available for use by AWS services that support tags.
  - Key (string) -- [REQUIRED]
    The tag's key.
  - Value (string) -- [REQUIRED]
    The tag's value.

Return type

dict

Returns

Response Syntax

{
    'HostArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- HostArn (string) --
  
  The Amazon Resource Name (ARN) of the host to be created.
- Tags (list) --
  - (dict) --
    
    A tag is a key-value pair that is used to manage the resource.
    
    This tag is available for use by AWS services that support tags.
    - Key (string) --
      
      The tag's key.
    - Value (string) --
      
      The tag's value.

Exceptions

CodeStarconnections.Client.exceptions.LimitExceededException

Table Of Contents

create_host¶