Package software.amazon.awscdk.services.proton

Interface CfnEnvironmentAccountConnectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentAccountConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:41.544Z")
@Stability(Stable)
public interface CfnEnvironmentAccountConnectionProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.proton.*;
 CfnEnvironmentAccountConnectionProps cfnEnvironmentAccountConnectionProps = CfnEnvironmentAccountConnectionProps.builder()
         .codebuildRoleArn("codebuildRoleArn")
         .componentRoleArn("componentRoleArn")
         .environmentAccountId("environmentAccountId")
         .environmentName("environmentName")
         .managementAccountId("managementAccountId")
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentAccountConnectionProps.Builder	A builder for CfnEnvironmentAccountConnectionProps
static final class	CfnEnvironmentAccountConnectionProps.Jsii$Proxy	An implementation for CfnEnvironmentAccountConnectionProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentAccountConnectionProps.Builder	builder()
default String	getCodebuildRoleArn()	The Amazon Resource Name (ARN) of an IAM service role in the environment account.
default String	getComponentRoleArn()	The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.
default String	getEnvironmentAccountId()	The environment account that's connected to the environment account connection.
default String	getEnvironmentName()	The name of the environment that's associated with the environment account connection.
default String	getManagementAccountId()	The ID of the management account that's connected to the environment account connection.
default String	getRoleArn()	The IAM service role that's associated with the environment account connection.
default List<CfnTag>	getTags()	An optional list of metadata items that you can associate with the AWS Proton environment account connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCodebuildRoleArn

@Stability(Stable)
@Nullable
default String getCodebuildRoleArn()

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.

See Also:

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

getComponentRoleArn

@Stability(Stable)
@Nullable
default String getComponentRoleArn()

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 .

See Also:

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

getEnvironmentAccountId

@Stability(Stable)
@Nullable
default String getEnvironmentAccountId()

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

See Also:

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

getEnvironmentName

@Stability(Stable)
@Nullable
default String getEnvironmentName()

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

See Also:

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

getManagementAccountId

@Stability(Stable)
@Nullable
default String getManagementAccountId()

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

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnEnvironmentAccountConnectionProps.Builder builder()

Returns:

a CfnEnvironmentAccountConnectionProps.Builder of CfnEnvironmentAccountConnectionProps