@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
141 lines (140 loc) • 5.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates a new landing zone using Control Tower. For more information on usage, please see the
* [AWS Control Tower Landing Zone User Guide](https://docs.aws.amazon.com/controltower/latest/userguide/how-control-tower-works.html).
*
* ## Import
*
* Using `pulumi import`, import a Control Tower Landing Zone using the `id`. For example:
*
* ```sh
* $ pulumi import aws:controltower/landingZone:LandingZone example 1A2B3C4D5E6F7G8H
* ```
*/
export declare class LandingZone extends pulumi.CustomResource {
/**
* Get an existing LandingZone resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LandingZoneState, opts?: pulumi.CustomResourceOptions): LandingZone;
/**
* Returns true if the given object is an instance of LandingZone. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LandingZone;
/**
* The ARN of the landing zone.
*/
readonly arn: pulumi.Output<string>;
/**
* The drift status summary of the landing zone.
*/
readonly driftStatuses: pulumi.Output<outputs.controltower.LandingZoneDriftStatus[]>;
/**
* The latest available version of the landing zone.
*/
readonly latestAvailableVersion: pulumi.Output<string>;
/**
* The manifest JSON file is a text file that describes your AWS resources. For examples, review [Launch your landing zone](https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch).
*/
readonly manifestJson: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Tags to apply to the landing zone. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the landing zone, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The landing zone version.
*/
readonly version: pulumi.Output<string>;
/**
* Create a LandingZone resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LandingZoneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LandingZone resources.
*/
export interface LandingZoneState {
/**
* The ARN of the landing zone.
*/
arn?: pulumi.Input<string>;
/**
* The drift status summary of the landing zone.
*/
driftStatuses?: pulumi.Input<pulumi.Input<inputs.controltower.LandingZoneDriftStatus>[]>;
/**
* The latest available version of the landing zone.
*/
latestAvailableVersion?: pulumi.Input<string>;
/**
* The manifest JSON file is a text file that describes your AWS resources. For examples, review [Launch your landing zone](https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch).
*/
manifestJson?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Tags to apply to the landing zone. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the landing zone, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The landing zone version.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LandingZone resource.
*/
export interface LandingZoneArgs {
/**
* The manifest JSON file is a text file that describes your AWS resources. For examples, review [Launch your landing zone](https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch).
*/
manifestJson: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Tags to apply to the landing zone. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The landing zone version.
*/
version: pulumi.Input<string>;
}