interface AutoDeploymentProperty

Language	Type name
.NET	`Amazon.CDK.CfnStackSet.AutoDeploymentProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2#CfnStackSet_AutoDeploymentProperty`
Java	`software.amazon.awscdk.CfnStackSet.AutoDeploymentProperty`
Python	`aws_cdk.CfnStackSet.AutoDeploymentProperty`
TypeScript	`aws-cdk-lib` » `CfnStackSet` » `AutoDeploymentProperty`

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

For more information, see Enable or disable automatic deployments for StackSets in AWS Organizations in the CloudFormation User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const autoDeploymentProperty: cdk.CfnStackSet.AutoDeploymentProperty = {
  dependsOn: ['dependsOn'],
  enabled: false,
  retainStacksOnAccountRemoval: false,
};

Properties

Name	Type	Description
dependsOn?	`string[]`	A list of StackSet ARNs that this StackSet depends on for auto-deployment operations.
enabled?	`boolean \|` `IResolvable`	If set to `true` , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions.
retainStacksOnAccountRemoval?	`boolean \|` `IResolvable`	If set to `true` , stack resources are retained when an account is removed from a target organization or OU.

dependsOn?

Type: string[] (optional)

A list of StackSet ARNs that this StackSet depends on for auto-deployment operations.

When auto-deployment is triggered, operations will be sequenced to ensure all dependencies complete successfully before this StackSet's operation begins.

enabled?

Type: boolean | IResolvable (optional)

If set to true , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions.

If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

retainStacksOnAccountRemoval?

Type: boolean | IResolvable (optional)

If set to true , stack resources are retained when an account is removed from a target organization or OU.

If set to false , stack resources are deleted. Specify only if Enabled is set to True .

AWS CDK