CfnEnvironmentAccountConnectionProps

class aws_cdk.aws_proton.CfnEnvironmentAccountConnectionProps(*, codebuild_role_arn=None, component_role_arn=None, environment_account_id=None, environment_name=None, management_account_id=None, role_arn=None, tags=None)

Bases: object

Properties for defining a CfnEnvironmentAccountConnection.

Parameters:
  • codebuild_role_arn (Optional[str]) – 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.

  • component_role_arn (Optional[str]) – 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 .

  • environment_account_id (Optional[str]) – The environment account that’s connected to the environment account connection.

  • environment_name (Optional[str]) – The name of the environment that’s associated with the environment account connection.

  • management_account_id (Optional[str]) – The ID of the management account that’s connected to the environment account connection.

  • role_arn (Optional[str]) – The IAM service role that’s associated with the environment account connection.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_proton as proton

cfn_environment_account_connection_props = proton.CfnEnvironmentAccountConnectionProps(
    codebuild_role_arn="codebuildRoleArn",
    component_role_arn="componentRoleArn",
    environment_account_id="environmentAccountId",
    environment_name="environmentName",
    management_account_id="managementAccountId",
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

codebuild_role_arn

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-codebuildrolearn

component_role_arn

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-componentrolearn

environment_account_id

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-environmentaccountid

environment_name

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-environmentname

management_account_id

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-managementaccountid

role_arn

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-rolearn

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html#cfn-proton-environmentaccountconnection-tags