Package software.amazon.awscdk.services.cloudformation

Interface CfnStackSetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnStackSetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-11-02T10:21:14.911Z") @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()
    The key-value pairs to associate with this stack set and the stacks created from it.
    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