AWS::CodeStarConnections::Connection - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::CodeStarConnections::Connection

AWS::CodeStarConnections::Connection 资源可用于将外部源提供程序与 AWS CodePipeline 等服务连接起来。

注意:默认情况下,通过 CloudFormation 创建的连接处于 PENDING 状态。您可以通过在控制台中更新连接来使其状态为 AVAILABLE

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

属性

ConnectionName

连接的名称。连接名称在 AWS 用户账户中必须唯一。

必需:是

类型:字符串

最低1

最高32

Update requires: Replacement

HostArn

与连接相关联的主机的 Amazon 资源名称 (ARN)。

必需:否

类型:字符串

最低0

最高256

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

Update requires: Replacement

ProviderType

在其中配置第三方代码存储库的外部提供程序的名称。

必需:否

类型:字符串

允许的值Bitbucket | GitHubEnterpriseServer

Update requires: Replacement

Tags

指定应用于此资源的标签。

必需:否

类型Tag 的列表

最高200

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回连接的 Amazon 资源名称 (ARN)。当连接在 AWS 服务之间共享时,ARN 用作连接引用。例如:

arn:aws:codestar-connections:us-west-2:123456789012:connection/39e4c34d-e13a-4e94-a886-ea67651bf042

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

ConnectionArn

连接的 Amazon 资源名称 (ARN)。当连接在 AWS 服务之间共享时,ARN 用作连接引用。例如:arn:aws:codestar-connections:us-west-2:123456789012:connection/39e4c34d-e13a-4e94-a886-ea67651bf042

ConnectionStatus

连接的当前状态。例如,PENDINGAVAILABLEERROR

OwnerAccountId

连接的拥有者的 AWS 账户 ID。对于 Bitbucket,这是 Bitbucket 存储库拥有者的账户 ID。例如:123456789012

示例

Bitbucket 连接配置

以下示例会创建与 Bitbucket 的连接。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "SampleConnection": { "Type": "AWS::CodeStarConnections::Connection", "Properties": { "ConnectionName": "MyConnection", "ProviderType": "Bitbucket", "Tags": [ { "Key": "Project", "Value": "ProjectB" } ] } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Resources: SampleConnection: Type: 'AWS::CodeStarConnections::Connection' Properties: ConnectionName: MyConnection ProviderType: Bitbucket Tags: - Key: Project Value: ProjectB

GitHub Enterprise Server 连接配置

以下示例会创建与 GitHub Enterprise Server 的连接。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "SampleConnection": { "Type": "AWS::CodeStarConnections::Connection", "Properties": { "ConnectionName": "MyConnection", "ProviderType": "GitHubEnterpriseServer", "HostArn": "arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example", "Tags": [ { "Key": "Project", "Value": "ProjectB" } ] } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Resources: SampleConnection: Type: 'AWS::CodeStarConnections::Connection' Properties: ConnectionName: MyConnection ProviderType: GitHubEnterpriseServer HostArn: 'arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example' Tags: - Key: Project Value: ProjectB