AWS CodeStar Connections Connections Host
This page shows how to write Terraform and CloudFormation for AWS CodeStar Connections Connections Host and write them securely.
aws_codestarconnections_host (Terraform)
The Connections Host in AWS CodeStar Connections can be configured in Terraform with the resource name aws_codestarconnections_host
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
The following arguments are supported:
name
- (Required) The name of the host to be created. The name must be unique in the calling AWS account.provider_endpoint
- (Required) The endpoint of the infrastructure to be represented by the host after it is created.provider_type
- (Required) The name of the external provider where your third-party code repository is configured.vpc_configuration
- (Optional) 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.
A vpc_configuration
block supports the following arguments:
security_group_ids
- (Required) he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.subnet_ids
- (Required) The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.tls_certificate
- (Optional) The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.vpc_id
- (Required) The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
In addition to all arguments above, the following attributes are exported:
id
- The CodeStar Host ARN.arn
- The CodeStar Host ARN.status
- The CodeStar Host status. Possible values arePENDING
,AVAILABLE
,VPC_CONFIG_DELETING
,VPC_CONFIG_INITIALIZING
, andVPC_CONFIG_FAILED_INITIALIZATION
.
Explanation in Terraform Registry
Provides a CodeStar Host.
NOTE: The
aws_codestarconnections_host
resource is created in the statePENDING
. Authentication with the host provider must be completed in the AWS Console. For more information visit Set up a pending host.
AWS::CodeStarConnections::Connection (CloudFormation)
The Connection in CodeStarConnections can be configured in CloudFormation with the resource name AWS::CodeStarConnections::Connection
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
ConnectionName
required - String -
ProviderType
optional - String -
HostArn
optional - String -
Tags
optional - List of Tag
Explanation in CloudFormation Registry
The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline. Note: A connection created through AWS CloudFormation is in
PENDING
status by default. You can make its statusAVAILABLE
by updating the connection in the console.