1.204.0

interface CfnEnvironmentAccountConnectionProps

This page is available in another version. Click here for the v2 documentation.

LanguageType name
.NETAmazon.CDK.AWS.Proton.CfnEnvironmentAccountConnectionProps
Javasoftware.amazon.awscdk.services.proton.CfnEnvironmentAccountConnectionProps
Pythonaws_cdk.aws_proton.CfnEnvironmentAccountConnectionProps
TypeScript @aws-cdk/aws-proton » CfnEnvironmentAccountConnectionProps

Properties for defining a CfnEnvironmentAccountConnection.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as proton from '@aws-cdk/aws-proton';
const cfnEnvironmentAccountConnectionProps: proton.CfnEnvironmentAccountConnectionProps = {
  codebuildRoleArn: 'codebuildRoleArn',
  componentRoleArn: 'componentRoleArn',
  environmentAccountId: 'environmentAccountId',
  environmentName: 'environmentName',
  managementAccountId: 'managementAccountId',
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
codebuildRoleArn?stringThe Amazon Resource Name (ARN) of an IAM service role in the environment account.
componentRoleArn?stringThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.
environmentAccountId?stringThe environment account that's connected to the environment account connection.
environmentName?stringThe name of the environment that's associated with the environment account connection.
managementAccountId?stringThe ID of the management account that's connected to the environment account connection.
roleArn?stringThe IAM service role that's associated with the environment account connection.
tags?CfnTag[]An optional list of metadata items that you can associate with the AWS Proton environment account connection.

codebuildRoleArn?

Type: string (optional)

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.

componentRoleArn?

Type: string (optional)

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 .

environmentAccountId?

Type: string (optional)

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

environmentName?

Type: string (optional)

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

managementAccountId?

Type: string (optional)

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

roleArn?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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 .

← PreviousNext →