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.
Contents
- HostArn
-
The Amazon Resource Name (ARN) of the host.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws(-[\w]+)*:(codestar-connections|codeconnections):.+:[0-9]{12}:host\/.+Required: No
- Name
-
The name of the host.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
.*Required: No
- ProviderEndpoint
-
The endpoint of the infrastructure where your provider type is installed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
.*Required: No
- 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.
Type: String
Valid Values:
Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManagedRequired: No
- Status
-
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
.*Required: No
- StatusMessage
-
The status description for the host.
Type: String
Required: No
- VpcConfiguration
-
The VPC configuration provisioned for the host.
Type: VpcConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
