Package software.amazon.awscdk.services.proton

Class CfnEnvironmentAccountConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.proton.CfnEnvironmentAccountConnection
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:01.010Z") @Stability(Stable) public class CfnEnvironmentAccountConnection extends CfnResource implements IInspectable
A CloudFormation AWS::Proton::EnvironmentAccountConnection.

Detailed data of an AWS Proton environment account connection resource.

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.*;
 CfnEnvironmentAccountConnection cfnEnvironmentAccountConnection = CfnEnvironmentAccountConnection.Builder.create(this, "MyCfnEnvironmentAccountConnection")
         .codebuildRoleArn("codebuildRoleArn")
         .componentRoleArn("componentRoleArn")
         .environmentAccountId("environmentAccountId")
         .environmentName("environmentName")
         .managementAccountId("managementAccountId")
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironmentAccountConnection

      protected CfnEnvironmentAccountConnection(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironmentAccountConnection

      protected CfnEnvironmentAccountConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironmentAccountConnection

      @Stability(Stable) public CfnEnvironmentAccountConnection(@NotNull Construct scope, @NotNull String id, @Nullable CfnEnvironmentAccountConnectionProps props)
      Create a new AWS::Proton::EnvironmentAccountConnection.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnEnvironmentAccountConnection

      @Stability(Stable) public CfnEnvironmentAccountConnection(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Proton::EnvironmentAccountConnection.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the environment account connection ARN.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      Returns the environment account connection ID.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Returns the environment account connection status.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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 .

    • getCodebuildRoleArn

      @Stability(Stable) @Nullable public 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.

    • setCodebuildRoleArn

      @Stability(Stable) public void setCodebuildRoleArn(@Nullable String value)
      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 public 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 .

    • setComponentRoleArn

      @Stability(Stable) public void setComponentRoleArn(@Nullable String value)
      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 public String getEnvironmentAccountId()
      The environment account that's connected to the environment account connection.

    • setEnvironmentAccountId

      @Stability(Stable) public void setEnvironmentAccountId(@Nullable String value)
      The environment account that's connected to the environment account connection.

    • getEnvironmentName

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

    • setEnvironmentName

      @Stability(Stable) public void setEnvironmentName(@Nullable String value)
      The name of the environment that's associated with the environment account connection.

    • getManagementAccountId

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

    • setManagementAccountId

      @Stability(Stable) public void setManagementAccountId(@Nullable String value)
      The ID of the management account that's connected to the environment account connection.

    • getRoleArn

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

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The IAM service role that's associated with the environment account connection.