software.amazon.awscdk

Interface CfnStackSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStackSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.489Z")
 @Stability(value=Stable)
public interface CfnStackSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::CloudFormation::StackSet`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 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()
                         .accounts(List.of("accounts"))
                         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStackSetProps.Builder A builder for CfnStackSetProps
static class	CfnStackSetProps.Jsii$Proxy An implementation for CfnStackSetProps

Method Summary

Modifier and Type	Method and Description
static CfnStackSetProps.Builder	builder()
default String	getAdministrationRoleArn() `AWS::CloudFormation::StackSet.AdministrationRoleARN`.
default Object	getAutoDeployment() `AWS::CloudFormation::StackSet.AutoDeployment`.
default String	getCallAs() `AWS::CloudFormation::StackSet.CallAs`.
default List<String>	getCapabilities() `AWS::CloudFormation::StackSet.Capabilities`.
default String	getDescription() `AWS::CloudFormation::StackSet.Description`.
default String	getExecutionRoleName() `AWS::CloudFormation::StackSet.ExecutionRoleName`.
default Object	getManagedExecution() `AWS::CloudFormation::StackSet.ManagedExecution`.
default Object	getOperationPreferences() `AWS::CloudFormation::StackSet.OperationPreferences`.
default Object	getParameters() `AWS::CloudFormation::StackSet.Parameters`.
String	getPermissionModel() `AWS::CloudFormation::StackSet.PermissionModel`.
default Object	getStackInstancesGroup() `AWS::CloudFormation::StackSet.StackInstancesGroup`.
String	getStackSetName() `AWS::CloudFormation::StackSet.StackSetName`.
default List<CfnTag>	getTags() `AWS::CloudFormation::StackSet.Tags`.
default String	getTemplateBody() `AWS::CloudFormation::StackSet.TemplateBody`.
default String	getTemplateUrl() `AWS::CloudFormation::StackSet.TemplateURL`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdministrationRoleArn

@Stability(value=Stable)
 @Nullable
default String getAdministrationRoleArn()

`AWS::CloudFormation::StackSet.AdministrationRoleARN`.

getAutoDeployment

@Stability(value=Stable)
 @Nullable
default Object getAutoDeployment()

`AWS::CloudFormation::StackSet.AutoDeployment`.

getCallAs

@Stability(value=Stable)
 @Nullable
default String getCallAs()

`AWS::CloudFormation::StackSet.CallAs`.

getCapabilities

@Stability(value=Stable)
 @Nullable
default List<String> getCapabilities()

`AWS::CloudFormation::StackSet.Capabilities`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::CloudFormation::StackSet.Description`.

getExecutionRoleName

@Stability(value=Stable)
 @Nullable
default String getExecutionRoleName()

`AWS::CloudFormation::StackSet.ExecutionRoleName`.

getManagedExecution

@Stability(value=Stable)
 @Nullable
default Object getManagedExecution()

`AWS::CloudFormation::StackSet.ManagedExecution`.

getOperationPreferences

@Stability(value=Stable)
 @Nullable
default Object getOperationPreferences()

`AWS::CloudFormation::StackSet.OperationPreferences`.

getParameters

@Stability(value=Stable)
 @Nullable
default Object getParameters()

`AWS::CloudFormation::StackSet.Parameters`.

getPermissionModel

@Stability(value=Stable)
 @NotNull
String getPermissionModel()

`AWS::CloudFormation::StackSet.PermissionModel`.

getStackInstancesGroup

@Stability(value=Stable)
 @Nullable
default Object getStackInstancesGroup()

`AWS::CloudFormation::StackSet.StackInstancesGroup`.

getStackSetName

@Stability(value=Stable)
 @NotNull
String getStackSetName()

`AWS::CloudFormation::StackSet.StackSetName`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::CloudFormation::StackSet.Tags`.

getTemplateBody

@Stability(value=Stable)
 @Nullable
default String getTemplateBody()

`AWS::CloudFormation::StackSet.TemplateBody`.

getTemplateUrl

@Stability(value=Stable)
 @Nullable
default String getTemplateUrl()

`AWS::CloudFormation::StackSet.TemplateURL`.

builder

@Stability(value=Stable)
static CfnStackSetProps.Builder builder()

Returns:

a CfnStackSetProps.Builder of CfnStackSetProps