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.84.0 (build 5404dcf)", date="2023-06-19T16:30:01.012Z") @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();

  • 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.

    • 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 .

    • getEnvironmentAccountId

      @Stability(Stable) @Nullable default String getEnvironmentAccountId()
      The environment account that's connected to the environment account connection.

    • getEnvironmentName

      @Stability(Stable) @Nullable default String getEnvironmentName()
      The name of the environment that's associated with the environment account connection.

    • getManagementAccountId

      @Stability(Stable) @Nullable default String getManagementAccountId()
      The ID of the management account that's connected to the environment account connection.

    • getRoleArn

      @Stability(Stable) @Nullable default String getRoleArn()
      The IAM service role that's associated with the environment account connection.

    • 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 .

    • builder

      @Stability(Stable) static CfnEnvironmentAccountConnectionProps.Builder builder()
      Returns:
      a CfnEnvironmentAccountConnectionProps.Builder of CfnEnvironmentAccountConnectionProps