`cloudformationStackSet` Submodule

Constructs

CloudformationStackSet

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set aws_cloudformation_stack_set}.

Initializers

import { cloudformationStackSet } from '@cdktf/aws-cdk'

new cloudformationStackSet.CloudformationStackSet(scope: Construct, id: string, config: CloudformationStackSetConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`CloudformationStackSetConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: CloudformationStackSetConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putAutoDeployment`	No description.
`putTimeouts`	No description.
`resetAdministrationRoleArn`	No description.
`resetAutoDeployment`	No description.
`resetCapabilities`	No description.
`resetDescription`	No description.
`resetExecutionRoleName`	No description.
`resetId`	No description.
`resetParameters`	No description.
`resetPermissionModel`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.
`resetTemplateBody`	No description.
`resetTemplateUrl`	No description.
`resetTimeouts`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putAutoDeployment`

public putAutoDeployment(value: CloudformationStackSetAutoDeployment): void

`value`^Required

Type: CloudformationStackSetAutoDeployment

`putTimeouts`

public putTimeouts(value: CloudformationStackSetTimeouts): void

`value`^Required

Type: CloudformationStackSetTimeouts

`resetAdministrationRoleArn`

public resetAdministrationRoleArn(): void

`resetAutoDeployment`

public resetAutoDeployment(): void

`resetCapabilities`

public resetCapabilities(): void

`resetDescription`

public resetDescription(): void

`resetExecutionRoleName`

public resetExecutionRoleName(): void

`resetId`

public resetId(): void

`resetParameters`

public resetParameters(): void

`resetPermissionModel`

public resetPermissionModel(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

`resetTemplateBody`

public resetTemplateBody(): void

`resetTemplateUrl`

public resetTemplateUrl(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a CloudformationStackSet resource upon running "cdktf plan ".

`isConstruct`

import { cloudformationStackSet } from '@cdktf/aws-cdk'

cloudformationStackSet.CloudformationStackSet.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { cloudformationStackSet } from '@cdktf/aws-cdk'

cloudformationStackSet.CloudformationStackSet.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { cloudformationStackSet } from '@cdktf/aws-cdk'

cloudformationStackSet.CloudformationStackSet.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { cloudformationStackSet } from '@cdktf/aws-cdk'

cloudformationStackSet.CloudformationStackSet.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a CloudformationStackSet resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the CloudformationStackSet to import.

`importFromId`^Required

Type: string

The id of the existing CloudformationStackSet that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the CloudformationStackSet to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`arn`	`string`	No description.
`autoDeployment`	`CloudformationStackSetAutoDeploymentOutputReference`	No description.
`stackSetId`	`string`	No description.
`timeouts`	`CloudformationStackSetTimeoutsOutputReference`	No description.
`administrationRoleArnInput`	`string`	No description.
`autoDeploymentInput`	`CloudformationStackSetAutoDeployment`	No description.
`capabilitiesInput`	`string[]`	No description.
`descriptionInput`	`string`	No description.
`executionRoleNameInput`	`string`	No description.
`idInput`	`string`	No description.
`nameInput`	`string`	No description.
`parametersInput`	`{[ key: string ]: string}`	No description.
`permissionModelInput`	`string`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`templateBodyInput`	`string`	No description.
`templateUrlInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| CloudformationStackSetTimeouts`	No description.
`administrationRoleArn`	`string`	No description.
`capabilities`	`string[]`	No description.
`description`	`string`	No description.
`executionRoleName`	`string`	No description.
`id`	`string`	No description.
`name`	`string`	No description.
`parameters`	`{[ key: string ]: string}`	No description.
`permissionModel`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: string}`	No description.
`templateBody`	`string`	No description.
`templateUrl`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`arn`^Required

public readonly arn: string;

Type: string

`autoDeployment`^Required

public readonly autoDeployment: CloudformationStackSetAutoDeploymentOutputReference;

Type: CloudformationStackSetAutoDeploymentOutputReference

`stackSetId`^Required

public readonly stackSetId: string;

Type: string

`timeouts`^Required

public readonly timeouts: CloudformationStackSetTimeoutsOutputReference;

Type: CloudformationStackSetTimeoutsOutputReference

`administrationRoleArnInput`^Optional

public readonly administrationRoleArnInput: string;

Type: string

`autoDeploymentInput`^Optional

public readonly autoDeploymentInput: CloudformationStackSetAutoDeployment;

Type: CloudformationStackSetAutoDeployment

`capabilitiesInput`^Optional

public readonly capabilitiesInput: string[];

Type: string[]

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`executionRoleNameInput`^Optional

public readonly executionRoleNameInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`parametersInput`^Optional

public readonly parametersInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`permissionModelInput`^Optional

public readonly permissionModelInput: string;

Type: string

`tagsAllInput`^Optional

public readonly tagsAllInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`tagsInput`^Optional

public readonly tagsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`templateBodyInput`^Optional

public readonly templateBodyInput: string;

Type: string

`templateUrlInput`^Optional

public readonly templateUrlInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | CloudformationStackSetTimeouts;

Type: cdktf.IResolvable | CloudformationStackSetTimeouts

`administrationRoleArn`^Required

public readonly administrationRoleArn: string;

Type: string

`capabilities`^Required

public readonly capabilities: string[];

Type: string[]

`description`^Required

public readonly description: string;

Type: string

`executionRoleName`^Required

public readonly executionRoleName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`parameters`^Required

public readonly parameters: {[ key: string ]: string};

Type: {[ key: string ]: string}

`permissionModel`^Required

public readonly permissionModel: string;

Type: string

`tags`^Required

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

`tagsAll`^Required

public readonly tagsAll: {[ key: string ]: string};

Type: {[ key: string ]: string}

`templateBody`^Required

public readonly templateBody: string;

Type: string

`templateUrl`^Required

public readonly templateUrl: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

CloudformationStackSetAutoDeployment

Initializer

import { cloudformationStackSet } from '@cdktf/aws-cdk'

const cloudformationStackSetAutoDeployment: cloudformationStackSet.CloudformationStackSetAutoDeployment = { ... }

Properties

Name	Type	Description
`enabled`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#enabled CloudformationStackSet#enabled}.
`retainStacksOnAccountRemoval`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#retain_stacks_on_account_removal CloudformationStackSet#retain_stacks_on_account_removal}.

`enabled`^Optional

public readonly enabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#enabled CloudformationStackSet#enabled}.

`retainStacksOnAccountRemoval`^Optional

public readonly retainStacksOnAccountRemoval: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#retain_stacks_on_account_removal CloudformationStackSet#retain_stacks_on_account_removal}.

CloudformationStackSetConfig

Initializer

import { cloudformationStackSet } from '@cdktf/aws-cdk'

const cloudformationStackSetConfig: cloudformationStackSet.CloudformationStackSetConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#name CloudformationStackSet#name}.
`administrationRoleArn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#administration_role_arn CloudformationStackSet#administration_role_arn}.
`autoDeployment`	`CloudformationStackSetAutoDeployment`	auto_deployment block.
`capabilities`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#capabilities CloudformationStackSet#capabilities}.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#description CloudformationStackSet#description}.
`executionRoleName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#execution_role_name CloudformationStackSet#execution_role_name}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#id CloudformationStackSet#id}.
`parameters`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#parameters CloudformationStackSet#parameters}.
`permissionModel`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#permission_model CloudformationStackSet#permission_model}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#tags CloudformationStackSet#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#tags_all CloudformationStackSet#tags_all}.
`templateBody`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#template_body CloudformationStackSet#template_body}.
`templateUrl`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#template_url CloudformationStackSet#template_url}.
`timeouts`	`CloudformationStackSetTimeouts`	timeouts block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#name CloudformationStackSet#name}.

`administrationRoleArn`^Optional

public readonly administrationRoleArn: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#administration_role_arn CloudformationStackSet#administration_role_arn}.

`autoDeployment`^Optional

public readonly autoDeployment: CloudformationStackSetAutoDeployment;

Type: CloudformationStackSetAutoDeployment

auto_deployment block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#auto_deployment CloudformationStackSet#auto_deployment}

`capabilities`^Optional

public readonly capabilities: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#capabilities CloudformationStackSet#capabilities}.

`description`^Optional

public readonly description: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#description CloudformationStackSet#description}.

`executionRoleName`^Optional

public readonly executionRoleName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#execution_role_name CloudformationStackSet#execution_role_name}.

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#id CloudformationStackSet#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`parameters`^Optional

public readonly parameters: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#parameters CloudformationStackSet#parameters}.

`permissionModel`^Optional

public readonly permissionModel: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#permission_model CloudformationStackSet#permission_model}.

`tags`^Optional

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#tags CloudformationStackSet#tags}.

`tagsAll`^Optional

public readonly tagsAll: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#tags_all CloudformationStackSet#tags_all}.

`templateBody`^Optional

public readonly templateBody: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#template_body CloudformationStackSet#template_body}.

`templateUrl`^Optional

public readonly templateUrl: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#template_url CloudformationStackSet#template_url}.

`timeouts`^Optional

public readonly timeouts: CloudformationStackSetTimeouts;

Type: CloudformationStackSetTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#timeouts CloudformationStackSet#timeouts}

CloudformationStackSetTimeouts

Initializer

import { cloudformationStackSet } from '@cdktf/aws-cdk'

const cloudformationStackSetTimeouts: cloudformationStackSet.CloudformationStackSetTimeouts = { ... }

Properties

Name	Type	Description
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#update CloudformationStackSet#update}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudformation_stack_set#update CloudformationStackSet#update}.

Classes

CloudformationStackSetAutoDeploymentOutputReference

Initializers

import { cloudformationStackSet } from '@cdktf/aws-cdk'

new cloudformationStackSet.CloudformationStackSetAutoDeploymentOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetEnabled`	No description.
`resetRetainStacksOnAccountRemoval`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetEnabled`

public resetEnabled(): void

`resetRetainStacksOnAccountRemoval`

public resetRetainStacksOnAccountRemoval(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`enabledInput`	`boolean \| cdktf.IResolvable`	No description.
`retainStacksOnAccountRemovalInput`	`boolean \| cdktf.IResolvable`	No description.
`enabled`	`boolean \| cdktf.IResolvable`	No description.
`retainStacksOnAccountRemoval`	`boolean \| cdktf.IResolvable`	No description.
`internalValue`	`CloudformationStackSetAutoDeployment`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`enabledInput`^Optional

public readonly enabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`retainStacksOnAccountRemovalInput`^Optional

public readonly retainStacksOnAccountRemovalInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`enabled`^Required

public readonly enabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`retainStacksOnAccountRemoval`^Required

public readonly retainStacksOnAccountRemoval: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`internalValue`^Optional

public readonly internalValue: CloudformationStackSetAutoDeployment;

Type: CloudformationStackSetAutoDeployment

CloudformationStackSetTimeoutsOutputReference

Initializers

import { cloudformationStackSet } from '@cdktf/aws-cdk'

new cloudformationStackSet.CloudformationStackSetTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetUpdate`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetUpdate`

public resetUpdate(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`updateInput`	`string`	No description.
`update`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| CloudformationStackSetTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | CloudformationStackSetTimeouts;

Type: cdktf.IResolvable | CloudformationStackSetTimeouts

Uh oh!

FilesExpand file tree

cloudformationStackSet.md

Latest commit

History

cloudformationStackSet.md

File metadata and controls

cloudformationStackSet Submodule

Constructs