AWS CodeStar Connections Connections Connection
This page shows how to write Terraform and CloudFormation for AWS CodeStar Connections Connections Connection and write them securely.
aws_codestarconnections_connection (Terraform)
The Connections Connection in AWS CodeStar Connections can be configured in Terraform with the resource name aws_codestarconnections_connection. The following sections describe 4 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_codestarconnections_connection" "example" {
name = "example-connection"
provider_type = "GitHub"
}
resource "aws_s3_bucket" "codepipeline_bucket" {
resource "aws_codestarconnections_connection" "github" {
name = join("-", [var.name, "gh-conn"])
provider_type = "GitHub"
}
module "pipeline" {
resource "aws_codestarconnections_connection" "example" {
name = "example-connection"
provider_type = "GitHub"
}
resource "aws_s3_bucket" "s3_bucket" {
resource "aws_codestarconnections_connection" "example" {
name = "example-connection"
provider_type = "GitHub"
}
resource "aws_iam_role" "codepipeline_role" {
Parameters
-
arnoptional computed - string -
connection_statusoptional computed - string -
idoptional computed - string -
namerequired - string -
provider_typerequired - string -
tagsoptional - map from string to string
Explanation in Terraform Registry
Provides a CodeStar Connection.
NOTE: The
aws_codestarconnections_connectionresource is created in the statePENDING. Authentication with the connection provider must be completed in the AWS Console.
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
-
ConnectionNamerequired - String -
ProviderTypeoptional - String -
HostArnoptional - String -
Tagsoptional - 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
PENDINGstatus by default. You can make its statusAVAILABLEby updating the connection in the console.
Frequently asked questions
What is AWS CodeStar Connections Connections Connection?
AWS CodeStar Connections Connections Connection is a resource for CodeStar Connections of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS CodeStar Connections Connections Connection?
For Terraform, the HemantTomar/pipe0, Young-ook/terraform-aws-lambda and pkuma343/aws-resource-tagging-poc-work source code examples are useful. See the Terraform Example section for further details.