AWS::CloudFormation::StackSet AutoDeployment - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::CloudFormation::StackSet AutoDeployment

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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "DependsOn" : [ String, ... ],
  "Enabled" : Boolean,
  "RetainStacksOnAccountRemoval" : Boolean
}

YAML

  DependsOn: 
    - String
  Enabled: Boolean
  RetainStacksOnAccountRemoval: Boolean

Properties

DependsOn

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.

Required: No

Type: Array of String

Update requires: No interruption

Enabled

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.

Required: No

Type: Boolean

Update requires: No interruption

RetainStacksOnAccountRemoval

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.

Required: Conditional

Type: Boolean

Update requires: No interruption