Skip to main content

connection

Gets an individual connection resource

Overview

Nameconnection
TypeResource
Descriptionconnection
Idawscc.codestarconnections.connection

Fields

NameDatatypeDescription
connection_arnstringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
connection_namestringThe name of the connection. Connection names must be unique in an AWS user account.
connection_statusstringThe current status of the connection.
owner_account_idstringThe name 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.
provider_typestringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
host_arnstringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
tagsarraySpecifies the tags applied to a connection.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
connection_arn,
connection_name,
connection_status,
owner_account_id,
provider_type,
host_arn,
tags
FROM awscc.codestarconnections.connection
WHERE data__Identifier = '<ConnectionArn>';

Permissions

To operate on the connection resource, the following permissions are required:

Read

codestar-connections:GetConnection,
codestar-connections:ListTagsForResource

Update

codestar-connections:ListTagsForResource,
codestar-connections:TagResource,
codestar-connections:UntagResource

Delete

codestar-connections:DeleteConnection