AWS::CodeConnections::Connection - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::CodeConnections::Connection

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

Note: A connection created through Amazon 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.

Syntax

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

JSON

{
  "Type" : "AWS::CodeConnections::Connection",
  "Properties" : {
      "ConnectionName" : String,
      "HostArn" : String,
      "ProviderType" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CodeConnections::Connection
Properties:
  ConnectionName: String
  HostArn: String
  ProviderType: String
  Tags: 
    - Tag

Properties

ConnectionName

The name of the connection. Connection names must be unique in an Amazon Web Services account.

Required: Yes

Type: String

Minimum: 1

Maximum: 32

Update requires: Replacement

HostArn

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

Required: No

Type: String

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

Minimum: 0

Maximum: 256

Update requires: Replacement

ProviderType

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

Required: No

Type: String

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

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ConnectionArn

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

Note

The ARN is never reused if the connection is deleted.

ConnectionStatus

The current status of the connection.

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.