Interface CfnStackSet.IAutoDeploymentProperty

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

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnStackSet.IAutoDeploymentProperty

Syntax (vb)

Public Interface CfnStackSet.IAutoDeploymentProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             var autoDeploymentProperty = new AutoDeploymentProperty {
                 DependsOn = new [] { "dependsOn" },
                 Enabled = false,
                 RetainStacksOnAccountRemoval = false
             };

Synopsis

Properties

DependsOn	A list of StackSet ARNs that this StackSet depends on for auto-deployment operations.
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.
RetainStacksOnAccountRemoval	If set to `true` , stack resources are retained when an account is removed from a target organization or OU.

Properties

DependsOn

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

string[]? DependsOn { get; }

Property Value

string[]

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-dependson

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.

object? Enabled { get; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-enabled

Type union: either bool or IResolvable

RetainStacksOnAccountRemoval

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

object? RetainStacksOnAccountRemoval { get; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-retainstacksonaccountremoval

Type union: either bool or IResolvable