Package software.amazon.awscdk.services.controltower

Class CfnLandingZone

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.controltower.CfnLandingZone
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-11T15:55:55.742Z") @Stability(Stable) public class CfnLandingZone extends CfnResource implements IInspectable, ITaggableV2
Creates a new landing zone.

This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.

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.controltower.*;
 Object manifest;
 CfnLandingZone cfnLandingZone = CfnLandingZone.Builder.create(this, "MyCfnLandingZone")
         .manifest(manifest)
         .version("version")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnLandingZone

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

    • CfnLandingZone

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

    • CfnLandingZone

      @Stability(Stable) public CfnLandingZone(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLandingZoneProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. 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()
      The ARN of the landing zone.

    • getAttrDriftStatus

      @Stability(Stable) @NotNull public String getAttrDriftStatus()
      The drift status of the landing zone.

    • getAttrLandingZoneIdentifier

      @Stability(Stable) @NotNull public String getAttrLandingZoneIdentifier()
      The unique identifier of the landing zone.

    • getAttrLatestAvailableVersion

      @Stability(Stable) @NotNull public String getAttrLatestAvailableVersion()
      The latest available version of the landing zone.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The landing zone deployment status.

      One of ACTIVE , PROCESSING , FAILED .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getManifest

      @Stability(Stable) @NotNull public Object getManifest()
      The landing zone manifest JSON text file that specifies the landing zone configurations.

    • setManifest

      @Stability(Stable) public void setManifest(@NotNull Object value)
      The landing zone manifest JSON text file that specifies the landing zone configurations.

    • getVersion

      @Stability(Stable) @NotNull public String getVersion()
      The landing zone's current deployed version.

    • setVersion

      @Stability(Stable) public void setVersion(@NotNull String value)
      The landing zone's current deployed version.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags to be applied to the landing zone.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags to be applied to the landing zone.