Connection - AWS CodeStar Connections

Connection

A resource that is used to connect third-party source providers with services like AWS CodePipeline.

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.

Contents

ConnectionArn

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.

Note

The ARN is never reused if the connection is deleted.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+

Required: No

ConnectionName

The name of the connection. Connection names must be unique in an AWS user account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

ConnectionStatus

The current status of the connection.

Type: String

Valid Values: PENDING | AVAILABLE | ERROR

Required: No

HostArn

The Amazon Resource Name (ARN) of the host associated with the connection.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws(-[\w]+)*:codestar-connections:.+:[0-9]{12}:host\/.+

Required: No

OwnerAccountId

The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

ProviderType

The name of the external provider where your third-party code repository is configured.

Type: String

Valid Values: Bitbucket | GitHubEnterpriseServer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: