software.amazon.awscdk

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.486Z")
 @Stability(value=Stable)
public class CfnStackSet
extends CfnResource
implements IInspectable

A CloudFormation `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;
 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()
                 .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	Class and Description
static interface	CfnStackSet.AutoDeploymentProperty Example:
static class	CfnStackSet.Builder A fluent builder for CfnStackSet.
static interface	CfnStackSet.DeploymentTargetsProperty Example:
static interface	CfnStackSet.OperationPreferencesProperty Example:
static interface	CfnStackSet.ParameterProperty Example:
static interface	CfnStackSet.StackInstancesProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStackSet(software.constructs.Construct scope, String id, CfnStackSetProps props) Create a new `AWS::CloudFormation::StackSet`.
protected	CfnStackSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStackSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAdministrationRoleArn() `AWS::CloudFormation::StackSet.AdministrationRoleARN`.
String	getAttrStackSetId()
Object	getAutoDeployment() `AWS::CloudFormation::StackSet.AutoDeployment`.
String	getCallAs() `AWS::CloudFormation::StackSet.CallAs`.
List<String>	getCapabilities() `AWS::CloudFormation::StackSet.Capabilities`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::CloudFormation::StackSet.Description`.
String	getExecutionRoleName() `AWS::CloudFormation::StackSet.ExecutionRoleName`.
Object	getManagedExecution() `AWS::CloudFormation::StackSet.ManagedExecution`.
Object	getOperationPreferences() `AWS::CloudFormation::StackSet.OperationPreferences`.
Object	getParameters() `AWS::CloudFormation::StackSet.Parameters`.
String	getPermissionModel() `AWS::CloudFormation::StackSet.PermissionModel`.
Object	getStackInstancesGroup() `AWS::CloudFormation::StackSet.StackInstancesGroup`.
String	getStackSetName() `AWS::CloudFormation::StackSet.StackSetName`.
TagManager	getTags() `AWS::CloudFormation::StackSet.Tags`.
String	getTemplateBody() `AWS::CloudFormation::StackSet.TemplateBody`.
String	getTemplateUrl() `AWS::CloudFormation::StackSet.TemplateURL`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdministrationRoleArn(String value) `AWS::CloudFormation::StackSet.AdministrationRoleARN`.
void	setAutoDeployment(CfnStackSet.AutoDeploymentProperty value) `AWS::CloudFormation::StackSet.AutoDeployment`.
void	setAutoDeployment(IResolvable value) `AWS::CloudFormation::StackSet.AutoDeployment`.
void	setCallAs(String value) `AWS::CloudFormation::StackSet.CallAs`.
void	setCapabilities(List<String> value) `AWS::CloudFormation::StackSet.Capabilities`.
void	setDescription(String value) `AWS::CloudFormation::StackSet.Description`.
void	setExecutionRoleName(String value) `AWS::CloudFormation::StackSet.ExecutionRoleName`.
void	setManagedExecution(Object value) `AWS::CloudFormation::StackSet.ManagedExecution`.
void	setOperationPreferences(CfnStackSet.OperationPreferencesProperty value) `AWS::CloudFormation::StackSet.OperationPreferences`.
void	setOperationPreferences(IResolvable value) `AWS::CloudFormation::StackSet.OperationPreferences`.
void	setParameters(IResolvable value) `AWS::CloudFormation::StackSet.Parameters`.
void	setParameters(List<Object> value) `AWS::CloudFormation::StackSet.Parameters`.
void	setPermissionModel(String value) `AWS::CloudFormation::StackSet.PermissionModel`.
void	setStackInstancesGroup(IResolvable value) `AWS::CloudFormation::StackSet.StackInstancesGroup`.
void	setStackInstancesGroup(List<Object> value) `AWS::CloudFormation::StackSet.StackInstancesGroup`.
void	setStackSetName(String value) `AWS::CloudFormation::StackSet.StackSetName`.
void	setTemplateBody(String value) `AWS::CloudFormation::StackSet.TemplateBody`.
void	setTemplateUrl(String value) `AWS::CloudFormation::StackSet.TemplateURL`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStackSet

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

CfnStackSet

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

CfnStackSet

@Stability(value=Stable)
public CfnStackSet(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnStackSetProps props)

Create a new `AWS::CloudFormation::StackSet`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAdministrationRoleArn

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

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

setAdministrationRoleArn

@Stability(value=Stable)
public void setAdministrationRoleArn(@Nullable
                                                              String value)

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

getAttrStackSetId

@Stability(value=Stable)
 @NotNull
public String getAttrStackSetId()

getAutoDeployment

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

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

setAutoDeployment

@Stability(value=Stable)
public void setAutoDeployment(@Nullable
                                                       IResolvable value)

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

setAutoDeployment

@Stability(value=Stable)
public void setAutoDeployment(@Nullable
                                                       CfnStackSet.AutoDeploymentProperty value)

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

getCallAs

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

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

setCallAs

@Stability(value=Stable)
public void setCallAs(@Nullable
                                               String value)

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

getCapabilities

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

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

setCapabilities

@Stability(value=Stable)
public void setCapabilities(@Nullable
                                                     List<String> value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

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

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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

getExecutionRoleName

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

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

setExecutionRoleName

@Stability(value=Stable)
public void setExecutionRoleName(@Nullable
                                                          String value)

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

getManagedExecution

@Stability(value=Stable)
 @NotNull
public Object getManagedExecution()

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

setManagedExecution

@Stability(value=Stable)
public void setManagedExecution(@NotNull
                                                         Object value)

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

getOperationPreferences

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

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

setOperationPreferences

@Stability(value=Stable)
public void setOperationPreferences(@Nullable
                                                             IResolvable value)

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

setOperationPreferences

@Stability(value=Stable)
public void setOperationPreferences(@Nullable
                                                             CfnStackSet.OperationPreferencesProperty value)

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

getParameters

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

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

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   IResolvable value)

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

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   List<Object> value)

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

getPermissionModel

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

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

setPermissionModel

@Stability(value=Stable)
public void setPermissionModel(@NotNull
                                                        String value)

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

getStackInstancesGroup

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

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

setStackInstancesGroup

@Stability(value=Stable)
public void setStackInstancesGroup(@Nullable
                                                            IResolvable value)

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

setStackInstancesGroup

@Stability(value=Stable)
public void setStackInstancesGroup(@Nullable
                                                            List<Object> value)

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

getStackSetName

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

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

setStackSetName

@Stability(value=Stable)
public void setStackSetName(@NotNull
                                                     String value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getTemplateBody

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

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

setTemplateBody

@Stability(value=Stable)
public void setTemplateBody(@Nullable
                                                     String value)

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

getTemplateUrl

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

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

setTemplateUrl

@Stability(value=Stable)
public void setTemplateUrl(@Nullable
                                                    String value)

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