Package software.amazon.awscdk.services.cloudformation

Class CfnStackSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudformation.CfnStackSet
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IStackSetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:59.965Z") @Stability(Stable) public class CfnStackSet extends CfnResource implements IInspectable, IStackSetRef, ITaggable
The AWS::CloudFormation::StackSet resource contains information about a StackSet.

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

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 software.amazon.awscdk.services.cloudformation.*;
 Object managedExecution;
 CfnStackSet cfnStackSet = CfnStackSet.Builder.create(this, "MyCfnStackSet")
         .permissionModel("permissionModel")
         .stackSetName("stackSetName")
         // the properties below are optional
         .administrationRoleArn("administrationRoleArn")
         .autoDeployment(AutoDeploymentProperty.builder()
                 .enabled(false)
                 .retainStacksOnAccountRemoval(false)
                 .build())
         .callAs("callAs")
         .capabilities(List.of("capabilities"))
         .description("description")
         .executionRoleName("executionRoleName")
         .managedExecution(managedExecution)
         .operationPreferences(OperationPreferencesProperty.builder()
                 .concurrencyMode("concurrencyMode")
                 .failureToleranceCount(123)
                 .failureTolerancePercentage(123)
                 .maxConcurrentCount(123)
                 .maxConcurrentPercentage(123)
                 .regionConcurrencyType("regionConcurrencyType")
                 .regionOrder(List.of("regionOrder"))
                 .build())
         .parameters(List.of(ParameterProperty.builder()
                 .parameterKey("parameterKey")
                 .parameterValue("parameterValue")
                 .build()))
         .stackInstancesGroup(List.of(StackInstancesProperty.builder()
                 .deploymentTargets(DeploymentTargetsProperty.builder()
                         .accountFilterType("accountFilterType")
                         .accounts(List.of("accounts"))
                         .accountsUrl("accountsUrl")
                         .organizationalUnitIds(List.of("organizationalUnitIds"))
                         .build())
                 .regions(List.of("regions"))
                 // the properties below are optional
                 .parameterOverrides(List.of(ParameterProperty.builder()
                         .parameterKey("parameterKey")
                         .parameterValue("parameterValue")
                         .build()))
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateBody("templateBody")
         .templateUrl("templateUrl")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStackSet

      protected CfnStackSet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStackSet

      protected CfnStackSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStackSet

      @Stability(Stable) public CfnStackSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStackSetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrStackSetId

      @Stability(Stable) @NotNull public String getAttrStackSetId()
      Returns the unique identifier of the resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStackSetRef

      @Stability(Stable) @NotNull public StackSetReference getStackSetRef()
      A reference to a StackSet resource.
      Specified by:
      getStackSetRef in interface IStackSetRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getPermissionModel

      @Stability(Stable) @NotNull public String getPermissionModel()
      Describes how the IAM roles required for StackSet operations are created.

    • setPermissionModel

      @Stability(Stable) public void setPermissionModel(@NotNull String value)
      Describes how the IAM roles required for StackSet operations are created.

    • getStackSetName

      @Stability(Stable) @NotNull public String getStackSetName()
      The name to associate with the StackSet.

    • setStackSetName

      @Stability(Stable) public void setStackSetName(@NotNull String value)
      The name to associate with the StackSet.

    • getAdministrationRoleArn

      @Stability(Stable) @Nullable public String getAdministrationRoleArn()
      The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.

    • setAdministrationRoleArn

      @Stability(Stable) public void setAdministrationRoleArn(@Nullable String value)
      The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.

    • getAutoDeployment

      @Stability(Stable) @Nullable public Object getAutoDeployment()
      Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

      Returns union: either IResolvable or CfnStackSet.AutoDeploymentProperty

    • setAutoDeployment

      @Stability(Stable) public void setAutoDeployment(@Nullable IResolvable value)
      Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

    • setAutoDeployment

      @Stability(Stable) public void setAutoDeployment(@Nullable CfnStackSet.AutoDeploymentProperty value)
      Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

    • getCallAs

      @Stability(Stable) @Nullable public String getCallAs()
      Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    • setCallAs

      @Stability(Stable) public void setCallAs(@Nullable String value)
      Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    • getCapabilities

      @Stability(Stable) @Nullable public List<String> getCapabilities()
      The capabilities that are allowed in the StackSet.

    • setCapabilities

      @Stability(Stable) public void setCapabilities(@Nullable List<String> value)
      The capabilities that are allowed in the StackSet.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the StackSet.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the StackSet.

    • getExecutionRoleName

      @Stability(Stable) @Nullable public String getExecutionRoleName()
      The name of the IAM execution role to use to create the StackSet.

    • setExecutionRoleName

      @Stability(Stable) public void setExecutionRoleName(@Nullable String value)
      The name of the IAM execution role to use to create the StackSet.

    • getManagedExecution

      @Stability(Stable) @Nullable public Object getManagedExecution()
      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    • setManagedExecution

      @Stability(Stable) public void setManagedExecution(@Nullable Object value)
      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    • getOperationPreferences

      @Stability(Stable) @Nullable public Object getOperationPreferences()
      The user-specified preferences for how CloudFormation performs a StackSet operation.

      Returns union: either IResolvable or CfnStackSet.OperationPreferencesProperty

    • setOperationPreferences

      @Stability(Stable) public void setOperationPreferences(@Nullable IResolvable value)
      The user-specified preferences for how CloudFormation performs a StackSet operation.

    • setOperationPreferences

      @Stability(Stable) public void setOperationPreferences(@Nullable CfnStackSet.OperationPreferencesProperty value)
      The user-specified preferences for how CloudFormation performs a StackSet operation.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      The input parameters for the StackSet template.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStackSet.ParameterProperty>

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      The input parameters for the StackSet template.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable List<Object> value)
      The input parameters for the StackSet template.

    • getStackInstancesGroup

      @Stability(Stable) @Nullable public Object getStackInstancesGroup()
      A group of stack instances with parameters in some specific accounts and Regions.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStackSet.StackInstancesProperty>

    • setStackInstancesGroup

      @Stability(Stable) public void setStackInstancesGroup(@Nullable IResolvable value)
      A group of stack instances with parameters in some specific accounts and Regions.

    • setStackInstancesGroup

      @Stability(Stable) public void setStackInstancesGroup(@Nullable List<Object> value)
      A group of stack instances with parameters in some specific accounts and Regions.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs to associate with this stack.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs to associate with this stack.

    • getTemplateBody

      @Stability(Stable) @Nullable public String getTemplateBody()
      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    • setTemplateBody

      @Stability(Stable) public void setTemplateBody(@Nullable String value)
      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    • getTemplateUrl

      @Stability(Stable) @Nullable public String getTemplateUrl()
      The URL of a file that contains the template body.

    • setTemplateUrl

      @Stability(Stable) public void setTemplateUrl(@Nullable String value)
      The URL of a file that contains the template body.