Create Host

codestarconnections_create_host

R Documentation

Creates a resource that represents the infrastructure where a third-party provider is installed¶

Description¶

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.

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

Usage¶

codestarconnections_create_host(Name, ProviderType, ProviderEndpoint,
  VpcConfiguration, Tags)

Arguments¶

Name: [required] The name of the host to be created.
ProviderType: [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: [required] The endpoint of the infrastructure to be represented by the host after it is created.
VpcConfiguration: 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.
Tags: Tags for the host to be created.

Value¶

A list with the following syntax:

list(
  HostArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax¶

svc$create_host(
  Name = "string",
  ProviderType = "Bitbucket"|"GitHub"|"GitHubEnterpriseServer"|"GitLab"|"GitLabSelfManaged",
  ProviderEndpoint = "string",
  VpcConfiguration = list(
    VpcId = "string",
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    ),
    TlsCertificate = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)