AWS::Proton::EnvironmentAccountConnection

Detailed data of an AWS Proton environment account connection resource.

Syntax

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

JSON

{
  "Type" : "AWS::Proton::EnvironmentAccountConnection",
  "Properties" : {
      "CodebuildRoleArn" : String,
      "ComponentRoleArn" : String,
      "EnvironmentAccountId" : String,
      "EnvironmentName" : String,
      "ManagementAccountId" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Proton::EnvironmentAccountConnection
Properties:
  CodebuildRoleArn: String
  ComponentRoleArn: String
  EnvironmentAccountId: String
  EnvironmentName: String
  ManagementAccountId: String
  RoleArn: String
  Tags: 
    - Tag

Properties

CodebuildRoleArn

The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$

Minimum: 1

Maximum: 200

Update requires: No interruption

ComponentRoleArn

The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

For more information about components, see AWS Proton components in the AWS Proton User Guide.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$

Minimum: 1

Maximum: 200

Update requires: No interruption

EnvironmentAccountId

The environment account that's connected to the environment account connection.

Required: No

Type: String

Pattern: ^\d{12}$

Update requires: No interruption

EnvironmentName

The name of the environment that's associated with the environment account connection.

Required: No

Type: String

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Minimum: 1

Maximum: 100

Update requires: No interruption

ManagementAccountId

The ID of the management account that's connected to the environment account connection.

Required: No

Type: String

Pattern: ^\d{12}$

Update requires: No interruption

RoleArn

The IAM service role that's associated with the environment account connection.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$

Minimum: 1

Maximum: 200

Update requires: No interruption

Tags

An optional list of metadata items that you can associate with the AWS Proton environment account connection. A tag is a key-value pair.

For more information, see AWS Proton resources and tagging in the AWS Proton User Guide.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the environment account connection.

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

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

Returns the environment account connection ARN.

Id

Returns the environment account connection ID.

Status

Returns the environment account connection status.