All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnStackSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-24T11:33:10.325Z") @Stability(Stable) public interface CfnStackSetProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStackSet.

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;
 CfnStackSetProps cfnStackSetProps = CfnStackSetProps.builder()
         .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnStackSetProps.Builder

A builder for CfnStackSetProps

static final class

CfnStackSetProps.Jsii$Proxy

An implementation for CfnStackSetProps
Method Summary

Modifier and Type

Method

Description

static CfnStackSetProps.Builder

builder()

default String

getAdministrationRoleArn()

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

default Object

getAutoDeployment()

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

default 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.

default List<String>

getCapabilities()

The capabilities that are allowed in the StackSet.

default String

getDescription()

A description of the StackSet.

default String

getExecutionRoleName()

The name of the IAM execution role to use to create the StackSet.

default Object

getManagedExecution()

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

default Object

getOperationPreferences()

The user-specified preferences for how CloudFormation performs a StackSet operation.

default Object

getParameters()

The input parameters for the StackSet template.

String

getPermissionModel()

Describes how the IAM roles required for StackSet operations are created.

default Object

getStackInstancesGroup()

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

String

getStackSetName()

The name to associate with the StackSet.

default List<CfnTag>

getTags()

Key-value pairs to associate with this stack.

default String

getTemplateBody()

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

default String

getTemplateUrl()

The URL of a file that contains the template body.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getPermissionModel
  
  @Stability(Stable) @NotNull String getPermissionModel()
  Describes how the IAM roles required for StackSet 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 permissions in the AWS CloudFormation User Guide .
  
  With SERVICE_MANAGED permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see Activate trusted access for StackSets with AWS Organizations in the AWS CloudFormation User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel
- getStackSetName
  
  @Stability(Stable) @NotNull String getStackSetName()
  
  The name to associate with the StackSet.
  The name must be unique in the Region where you create your StackSet.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname
- getAdministrationRoleArn
  
  @Stability(Stable) @Nullable default String getAdministrationRoleArn()
  
  The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.
  Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account.
  Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the AWS CloudFormation User Guide .
  Valid only if the permissions model is SELF_MANAGED .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn
- getAutoDeployment
  
  @Stability(Stable) @Nullable default Object getAutoDeployment()
  
  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 AWS CloudFormation User Guide .
  Required if the permissions model is SERVICE_MANAGED . (Not used with self-managed permissions.)
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment
- getCallAs
  
  @Stability(Stable) @Nullable default 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.
  By default, SELF is specified. Use SELF for StackSets with self-managed permissions.
  
  To create a StackSet with service-managed permissions while signed in to the management account, specify SELF .
  
  To create a StackSet 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 .
  StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.
  Valid only if the permissions model is SERVICE_MANAGED .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas
- getCapabilities
  
  @Stability(Stable) @Nullable default List<String> getCapabilities()
  
  The capabilities that are allowed in the StackSet.
  Some StackSet templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see Acknowledging IAM resources in CloudFormation templates in the AWS CloudFormation User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  A description of the StackSet.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description
- getExecutionRoleName
  
  @Stability(Stable) @Nullable default String getExecutionRoleName()
  
  The name of the IAM execution role to use to create the StackSet.
  If you don't specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.
  Valid only if the permissions model is SELF_MANAGED .
  Pattern : [a-zA-Z_0-9+=,.@-]+
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename
- getManagedExecution
  
  @Stability(Stable) @Nullable default Object getManagedExecution()
  
  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 StackSet's execution configuration while there are running or queued operations for that StackSet.
  
  When inactive (default), StackSets performs one operation at a time in request order.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution
- getOperationPreferences
  
  @Stability(Stable) @Nullable default Object getOperationPreferences()
  
  The user-specified preferences for how CloudFormation performs a StackSet operation.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences
- getParameters
  
  @Stability(Stable) @Nullable default Object getParameters()
  
  The input parameters for the StackSet template.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters
- getStackInstancesGroup
  
  @Stability(Stable) @Nullable default Object getStackInstancesGroup()
  
  A group of stack instances with parameters in some specific accounts and Regions.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags
- getTemplateBody
  
  @Stability(Stable) @Nullable default String getTemplateBody()
  
  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 that contain dynamic references through TemplateUrl instead.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody
- getTemplateUrl
  
  @Stability(Stable) @Nullable default String getTemplateUrl()
  
  The URL of a file that contains the template body.
  The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https:// .
  Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl
- builder
  
  @Stability(Stable) static CfnStackSetProps.Builder builder()
  
  Returns:
  
  a CfnStackSetProps.Builder of CfnStackSetProps

Interface CfnStackSetProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getPermissionModel

getStackSetName

getAdministrationRoleArn

getAutoDeployment

getCallAs

getCapabilities

getDescription

getExecutionRoleName

getManagedExecution

getOperationPreferences

getParameters

getStackInstancesGroup

getTags

getTemplateBody

getTemplateUrl

builder