class CfnStackSet (construct)

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

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::CloudFormation::StackSet enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template.

In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

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';

declare const managedExecution: any;
const cfnStackSet = new cdk.CfnStackSet(this, 'MyCfnStackSet', {
  permissionModel: 'permissionModel',
  stackSetName: 'stackSetName',

  // the properties below are optional
  administrationRoleArn: 'administrationRoleArn',
  autoDeployment: {
    enabled: false,
    retainStacksOnAccountRemoval: false,
  },
  callAs: 'callAs',
  capabilities: ['capabilities'],
  description: 'description',
  executionRoleName: 'executionRoleName',
  managedExecution: managedExecution,
  operationPreferences: {
    concurrencyMode: 'concurrencyMode',
    failureToleranceCount: 123,
    failureTolerancePercentage: 123,
    maxConcurrentCount: 123,
    maxConcurrentPercentage: 123,
    regionConcurrencyType: 'regionConcurrencyType',
    regionOrder: ['regionOrder'],
  },
  parameters: [{
    parameterKey: 'parameterKey',
    parameterValue: 'parameterValue',
  }],
  stackInstancesGroup: [{
    deploymentTargets: {
      accountFilterType: 'accountFilterType',
      accounts: ['accounts'],
      accountsUrl: 'accountsUrl',
      organizationalUnitIds: ['organizationalUnitIds'],
    },
    regions: ['regions'],

    // the properties below are optional
    parameterOverrides: [{
      parameterKey: 'parameterKey',
      parameterValue: 'parameterValue',
    }],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateBody: 'templateBody',
  templateUrl: 'templateUrl',
});

Initializer

new CfnStackSet(scope: Construct, id: string, props: CfnStackSetProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnStackSetProps — Resource properties.

Construct Props

Name	Type	Description
permissionModel	`string`	Describes how the IAM roles required for stack set operations are created.
stackSetName	`string`	The name to associate with the stack set.
administrationRoleArn?	`string`	The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
autoDeployment?	`IResolvable` `\|` `AutoDeploymentProperty`	[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
callAs?	`string`	[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
capabilities?	`string[]`	The capabilities that are allowed in the stack set.
description?	`string`	A description of the stack set.
executionRoleName?	`string`	The name of the IAM execution role to use to create the stack set.
managedExecution?	`any`	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
operationPreferences?	`IResolvable` `\|` `OperationPreferencesProperty`	The user-specified preferences for how AWS CloudFormation performs a stack set operation.
parameters?	`IResolvable` `\|` `IResolvable` `\|` `ParameterProperty[]`	The input parameters for the stack set template.
stackInstancesGroup?	`IResolvable` `\|` `IResolvable` `\|` `StackInstancesProperty[]`	A group of stack instances with parameters in some specific accounts and Regions.
tags?	`CfnTag[]`	Key-value pairs to associate with this stack.
templateBody?	`string`	The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
templateUrl?	`string`	Location of file containing the template body.

permissionModel

Type: string

Describes how the IAM roles required for stack set operations are created.

With SELF_MANAGED permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions .
With SERVICE_MANAGED permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations .

stackSetName

Type: string

The name to associate with the stack set.

The name must be unique in the Region where you create your stack set.

The StackSetName property is required.

administrationRoleArn?

Type: string (optional)

The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide .

Minimum : 20

Maximum : 2048

autoDeployment?

Type: IResolvable | AutoDeploymentProperty (optional)

[ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

callAs?

Type: string (optional)

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

To create a stack set with service-managed permissions while signed in to the management account, specify SELF .
To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN .

Your AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Valid Values : SELF | DELEGATED_ADMIN

capabilities?

Type: string[] (optional)

The capabilities that are allowed in the stack set.

Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

description?

Type: string (optional)

A description of the stack set.

Minimum : 1

Maximum : 1024

executionRoleName?

Type: string (optional)

The name of the IAM execution role to use to create the stack set.

If you don't specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Minimum : 1

Maximum : 64

Pattern : [a-zA-Z_0-9+=,.@-]+

managedExecution?

Type: any (optional)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

When inactive (default), StackSets performs one operation at a time in request order.

operationPreferences?

Type: IResolvable | OperationPreferencesProperty (optional)

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

parameters?

Type: IResolvable | IResolvable | ParameterProperty[] (optional)

The input parameters for the stack set template.

stackInstancesGroup?

Type: IResolvable | IResolvable | StackInstancesProperty[] (optional)

A group of stack instances with parameters in some specific accounts and Regions.

tags?

Type: CfnTag[] (optional)

Key-value pairs to associate with this stack.

CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

templateBody?

Type: string (optional)

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both. Dynamic references in the TemplateBody may not work correctly in all cases. It's recommended to pass templates containing dynamic references through TemplateUrl instead.

templateUrl?

Type: string (optional)

Location of file containing the template body.

The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL .

Properties

Name	Type	Description
attrStackSetId	`string`	The ID of the stack that you're creating.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
permissionModel	`string`	Describes how the IAM roles required for stack set operations are created.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
stackSetName	`string`	The name to associate with the stack set.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
administrationRoleArn?	`string`	The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
autoDeployment?	`IResolvable` `\|` `AutoDeploymentProperty`	[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
callAs?	`string`	[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
capabilities?	`string[]`	The capabilities that are allowed in the stack set.
description?	`string`	A description of the stack set.
executionRoleName?	`string`	The name of the IAM execution role to use to create the stack set.
managedExecution?	`any`	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
operationPreferences?	`IResolvable` `\|` `OperationPreferencesProperty`	The user-specified preferences for how AWS CloudFormation performs a stack set operation.
parameters?	`IResolvable` `\|` `IResolvable` `\|` `ParameterProperty[]`	The input parameters for the stack set template.
stackInstancesGroup?	`IResolvable` `\|` `IResolvable` `\|` `StackInstancesProperty[]`	A group of stack instances with parameters in some specific accounts and Regions.
tagsRaw?	`CfnTag[]`	Key-value pairs to associate with this stack.
templateBody?	`string`	The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
templateUrl?	`string`	Location of file containing the template body.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrStackSetId

Type: string

The ID of the stack that you're creating.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

permissionModel

Type: string

Describes how the IAM roles required for stack set operations are created.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stackSetName

Type: string

The name to associate with the stack set.

administrationRoleArn?

Type: string (optional)

The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

autoDeployment?

Type: IResolvable | AutoDeploymentProperty (optional)

[ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

callAs?

Type: string (optional)

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

capabilities?

Type: string[] (optional)

The capabilities that are allowed in the stack set.

description?

Type: string (optional)

A description of the stack set.

executionRoleName?

Type: string (optional)

The name of the IAM execution role to use to create the stack set.

managedExecution?

Type: any (optional)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

operationPreferences?

Type: IResolvable | OperationPreferencesProperty (optional)

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

parameters?

Type: IResolvable | IResolvable | ParameterProperty[] (optional)

The input parameters for the stack set template.

stackInstancesGroup?

Type: IResolvable | IResolvable | StackInstancesProperty[] (optional)

A group of stack instances with parameters in some specific accounts and Regions.

tagsRaw?

Type: CfnTag[] (optional)

Key-value pairs to associate with this stack.

templateBody?

Type: string (optional)

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

templateUrl?

Type: string (optional)

Location of file containing the template body.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

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

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }