All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnStackSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:13.572Z") @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()
                 .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 stack set.

default Object

getAutoDeployment()

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

default String

getCallAs()

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

default List<String>

getCapabilities()

The capabilities that are allowed in the stack set.

default String

getDescription()

A description of the stack set.

default String

getExecutionRoleName()

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

default Object

getManagedExecution()

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

default Object

getOperationPreferences()

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

default Object

getParameters()

The input parameters for the stack set template.

String

getPermissionModel()

Describes how the IAM roles required for stack set 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 stack set.

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()

Location of file containing 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 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 .
  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 stack set.
  The name must be unique in the Region where you create your stack set.
  
  The StackSetName property is required.
  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 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
  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()
  
  [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
  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()
  [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
  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 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 .
  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 stack set.
  Minimum : 1
  Maximum : 1024
  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 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+=,.@-]+
  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 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.
  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 AWS CloudFormation performs a stack set 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 stack set 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.
  AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS 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 containing 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()
  
  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 .
  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