Class CfnLandingZone
Creates a new landing zone.
Inherited Members
Namespace: Amazon.CDK.AWS.ControlTower
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLandingZone : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnLandingZone Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ControlTower;
var manifest;
var cfnLandingZone = new CfnLandingZone(this, "MyCfnLandingZone", new CfnLandingZoneProps {
Manifest = manifest,
Version = "version",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnLandingZone(Construct, string, ICfnLandingZoneProps) | Creates a new landing zone. |
Properties
AttrArn | The ARN of the landing zone. |
AttrDriftStatus | The drift status of the landing zone. |
AttrLandingZoneIdentifier | The unique identifier of the landing zone. |
AttrLatestAvailableVersion | The latest available version of the landing zone. |
AttrStatus | The landing zone deployment status. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CfnProperties | Creates a new landing zone. |
Manifest | The landing zone manifest JSON text file that specifies the landing zone configurations. |
Tags | Tags to be applied to the landing zone. |
Version | The landing zone's current deployed version. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | Creates a new landing zone. |
Constructors
CfnLandingZone(Construct, string, ICfnLandingZoneProps)
Creates a new landing zone.
public CfnLandingZone(Construct scope, string id, ICfnLandingZoneProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnLandingZoneProps
Resource properties.
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
Properties
AttrArn
The ARN of the landing zone.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: Arn
AttrDriftStatus
The drift status of the landing zone.
public virtual string AttrDriftStatus { get; }
Property Value
Remarks
CloudformationAttribute: DriftStatus
AttrLandingZoneIdentifier
The unique identifier of the landing zone.
public virtual string AttrLandingZoneIdentifier { get; }
Property Value
Remarks
CloudformationAttribute: LandingZoneIdentifier
AttrLatestAvailableVersion
The latest available version of the landing zone.
public virtual string AttrLatestAvailableVersion { get; }
Property Value
Remarks
CloudformationAttribute: LatestAvailableVersion
AttrStatus
The landing zone deployment status.
public virtual string AttrStatus { get; }
Property Value
Remarks
One of ACTIVE
, PROCESSING
, FAILED
.
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
CfnProperties
Creates a new landing zone.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
Manifest
The landing zone manifest JSON text file that specifies the landing zone configurations.
public virtual object Manifest { get; set; }
Property Value
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
Tags
Tags to be applied to the landing zone.
public virtual ICfnTag[]? Tags { get; set; }
Property Value
ICfnTag[]
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
Version
The landing zone's current deployed version.
public virtual string Version { get; set; }
Property Value
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates a new landing zone.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
CloudformationResource: AWS::ControlTower::LandingZone
ExampleMetadata: fixture=_generated