1. Packages
  2. AWS Classic
  3. API Docs
  4. controltower
  5. LandingZone

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws.controltower.LandingZone

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Creates a new landing zone using Control Tower. For more information on usage, please see the AWS Control Tower Landing Zone User Guide.

    Create LandingZone Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LandingZone(name: string, args: LandingZoneArgs, opts?: CustomResourceOptions);
    @overload
    def LandingZone(resource_name: str,
                    args: LandingZoneArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def LandingZone(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    manifest_json: Optional[str] = None,
                    version: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewLandingZone(ctx *Context, name string, args LandingZoneArgs, opts ...ResourceOption) (*LandingZone, error)
    public LandingZone(string name, LandingZoneArgs args, CustomResourceOptions? opts = null)
    public LandingZone(String name, LandingZoneArgs args)
    public LandingZone(String name, LandingZoneArgs args, CustomResourceOptions options)
    
    type: aws:controltower:LandingZone
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LandingZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LandingZoneArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LandingZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LandingZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LandingZoneArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var landingZoneResource = new Aws.ControlTower.LandingZone("landingZoneResource", new()
    {
        ManifestJson = "string",
        Version = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := controltower.NewLandingZone(ctx, "landingZoneResource", &controltower.LandingZoneArgs{
    	ManifestJson: pulumi.String("string"),
    	Version:      pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var landingZoneResource = new LandingZone("landingZoneResource", LandingZoneArgs.builder()
        .manifestJson("string")
        .version("string")
        .tags(Map.of("string", "string"))
        .build());
    
    landing_zone_resource = aws.controltower.LandingZone("landingZoneResource",
        manifest_json="string",
        version="string",
        tags={
            "string": "string",
        })
    
    const landingZoneResource = new aws.controltower.LandingZone("landingZoneResource", {
        manifestJson: "string",
        version: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:controltower:LandingZone
    properties:
        manifestJson: string
        tags:
            string: string
        version: string
    

    LandingZone Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LandingZone resource accepts the following input properties:

    ManifestJson string
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    Version string
    The landing zone version.
    Tags Dictionary<string, string>
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ManifestJson string
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    Version string
    The landing zone version.
    Tags map[string]string
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    manifestJson String
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    version String
    The landing zone version.
    tags Map<String,String>
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    manifestJson string
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    version string
    The landing zone version.
    tags {[key: string]: string}
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    manifest_json str
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    version str
    The landing zone version.
    tags Mapping[str, str]
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    manifestJson String
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    version String
    The landing zone version.
    tags Map<String>
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LandingZone resource produces the following output properties:

    Arn string
    The ARN of the landing zone.
    DriftStatuses List<LandingZoneDriftStatus>
    The drift status summary of the landing zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestAvailableVersion string
    The latest available version of the landing zone.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the landing zone.
    DriftStatuses []LandingZoneDriftStatus
    The drift status summary of the landing zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestAvailableVersion string
    The latest available version of the landing zone.
    TagsAll map[string]string
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the landing zone.
    driftStatuses List<LandingZoneDriftStatus>
    The drift status summary of the landing zone.
    id String
    The provider-assigned unique ID for this managed resource.
    latestAvailableVersion String
    The latest available version of the landing zone.
    tagsAll Map<String,String>
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the landing zone.
    driftStatuses LandingZoneDriftStatus[]
    The drift status summary of the landing zone.
    id string
    The provider-assigned unique ID for this managed resource.
    latestAvailableVersion string
    The latest available version of the landing zone.
    tagsAll {[key: string]: string}
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the landing zone.
    drift_statuses Sequence[LandingZoneDriftStatus]
    The drift status summary of the landing zone.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_available_version str
    The latest available version of the landing zone.
    tags_all Mapping[str, str]
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the landing zone.
    driftStatuses List<Property Map>
    The drift status summary of the landing zone.
    id String
    The provider-assigned unique ID for this managed resource.
    latestAvailableVersion String
    The latest available version of the landing zone.
    tagsAll Map<String>
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing LandingZone Resource

    Get an existing LandingZone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LandingZoneState, opts?: CustomResourceOptions): LandingZone
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            drift_statuses: Optional[Sequence[LandingZoneDriftStatusArgs]] = None,
            latest_available_version: Optional[str] = None,
            manifest_json: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            version: Optional[str] = None) -> LandingZone
    func GetLandingZone(ctx *Context, name string, id IDInput, state *LandingZoneState, opts ...ResourceOption) (*LandingZone, error)
    public static LandingZone Get(string name, Input<string> id, LandingZoneState? state, CustomResourceOptions? opts = null)
    public static LandingZone get(String name, Output<String> id, LandingZoneState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the landing zone.
    DriftStatuses List<LandingZoneDriftStatus>
    The drift status summary of the landing zone.
    LatestAvailableVersion string
    The latest available version of the landing zone.
    ManifestJson string
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    Tags Dictionary<string, string>
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    The landing zone version.
    Arn string
    The ARN of the landing zone.
    DriftStatuses []LandingZoneDriftStatusArgs
    The drift status summary of the landing zone.
    LatestAvailableVersion string
    The latest available version of the landing zone.
    ManifestJson string
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    Tags map[string]string
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    The landing zone version.
    arn String
    The ARN of the landing zone.
    driftStatuses List<LandingZoneDriftStatus>
    The drift status summary of the landing zone.
    latestAvailableVersion String
    The latest available version of the landing zone.
    manifestJson String
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    tags Map<String,String>
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    The landing zone version.
    arn string
    The ARN of the landing zone.
    driftStatuses LandingZoneDriftStatus[]
    The drift status summary of the landing zone.
    latestAvailableVersion string
    The latest available version of the landing zone.
    manifestJson string
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    tags {[key: string]: string}
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version string
    The landing zone version.
    arn str
    The ARN of the landing zone.
    drift_statuses Sequence[LandingZoneDriftStatusArgs]
    The drift status summary of the landing zone.
    latest_available_version str
    The latest available version of the landing zone.
    manifest_json str
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    tags Mapping[str, str]
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version str
    The landing zone version.
    arn String
    The ARN of the landing zone.
    driftStatuses List<Property Map>
    The drift status summary of the landing zone.
    latestAvailableVersion String
    The latest available version of the landing zone.
    manifestJson String
    The manifest JSON file is a text file that describes your AWS resources. For examples, review Launch your landing zone.
    tags Map<String>
    Tags to apply to the landing zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the landing zone, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    The landing zone version.

    Supporting Types

    LandingZoneDriftStatus, LandingZoneDriftStatusArgs

    Status string
    The drift status of the landing zone.
    Status string
    The drift status of the landing zone.
    status String
    The drift status of the landing zone.
    status string
    The drift status of the landing zone.
    status str
    The drift status of the landing zone.
    status String
    The drift status of the landing zone.

    Import

    Using pulumi import, import a Control Tower Landing Zone using the id. For example:

    $ pulumi import aws:controltower/landingZone:LandingZone example 1A2B3C4D5E6F7G8H
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi