View a markdown version of this page

AWS::CodeConnections::Host - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::CodeConnections::Host

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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CodeConnections::Host",
  "Properties" : {
      "Name" : String,
      "ProviderEndpoint" : String,
      "ProviderType" : String,
      "Tags" : [ Tag, ... ],
      "VpcConfiguration" : VpcConfiguration
    }
}

YAML

Type: AWS::CodeConnections::Host
Properties:
  Name: String
  ProviderEndpoint: String
  ProviderType: String
  Tags: 
    - Tag
  VpcConfiguration: 
    VpcConfiguration

Properties

Name

The name of the host.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

ProviderEndpoint

The endpoint of the infrastructure where your provider type is installed.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption

ProviderType

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.

Required: Yes

Type: String

Allowed values: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged | AzureDevOps

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

VpcConfiguration

The VPC configuration provisioned for the host.

Required: No

Type: VpcConfiguration

Update requires: No interruption

Return values

Ref

Fn::GetAtt

HostArn

The Amazon Resource Name (ARN) of the host.

HostId

Property description not available.

Status

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.