StackSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.model.StackSet

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StackSet
extends Object
implements Serializable, Cloneable
```
A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StackSet()

Constructors
Constructor and Description
`StackSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StackSet`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdministrationRoleARN()` The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
`List<String>`	`getCapabilities()` The capabilities that are allowed in the stack set.
`String`	`getDescription()` A description of the stack set that you specify when the stack set is created or updated.
`String`	`getExecutionRoleName()` The name of the IAM execution role used to create or update the stack set.
`List<Parameter>`	`getParameters()` A list of input parameters for a stack set.
`String`	`getStackSetARN()` The Amazon Resource Number (ARN) of the stack set.
`String`	`getStackSetId()` The ID of the stack set.
`String`	`getStackSetName()` The name that's associated with the stack set.
`String`	`getStatus()` The status of the stack set.
`List<Tag>`	`getTags()` A list of tags that specify information about the stack set.
`String`	`getTemplateBody()` The structure that contains the body of the template that was used to create or update the stack set.
`int`	`hashCode()`
`void`	`setAdministrationRoleARN(String administrationRoleARN)` The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
`void`	`setCapabilities(Collection<String> capabilities)` The capabilities that are allowed in the stack set.
`void`	`setDescription(String description)` A description of the stack set that you specify when the stack set is created or updated.
`void`	`setExecutionRoleName(String executionRoleName)` The name of the IAM execution role used to create or update the stack set.
`void`	`setParameters(Collection<Parameter> parameters)` A list of input parameters for a stack set.
`void`	`setStackSetARN(String stackSetARN)` The Amazon Resource Number (ARN) of the stack set.
`void`	`setStackSetId(String stackSetId)` The ID of the stack set.
`void`	`setStackSetName(String stackSetName)` The name that's associated with the stack set.
`void`	`setStatus(StackSetStatus status)` The status of the stack set.
`void`	`setStatus(String status)` The status of the stack set.
`void`	`setTags(Collection<Tag> tags)` A list of tags that specify information about the stack set.
`void`	`setTemplateBody(String templateBody)` The structure that contains the body of the template that was used to create or update the stack set.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StackSet`	`withAdministrationRoleARN(String administrationRoleARN)` The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
`StackSet`	`withCapabilities(Capability... capabilities)` The capabilities that are allowed in the stack set.
`StackSet`	`withCapabilities(Collection<String> capabilities)` The capabilities that are allowed in the stack set.
`StackSet`	`withCapabilities(String... capabilities)` The capabilities that are allowed in the stack set.
`StackSet`	`withDescription(String description)` A description of the stack set that you specify when the stack set is created or updated.
`StackSet`	`withExecutionRoleName(String executionRoleName)` The name of the IAM execution role used to create or update the stack set.
`StackSet`	`withParameters(Collection<Parameter> parameters)` A list of input parameters for a stack set.
`StackSet`	`withParameters(Parameter... parameters)` A list of input parameters for a stack set.
`StackSet`	`withStackSetARN(String stackSetARN)` The Amazon Resource Number (ARN) of the stack set.
`StackSet`	`withStackSetId(String stackSetId)` The ID of the stack set.
`StackSet`	`withStackSetName(String stackSetName)` The name that's associated with the stack set.
`StackSet`	`withStatus(StackSetStatus status)` The status of the stack set.
`StackSet`	`withStatus(String status)` The status of the stack set.
`StackSet`	`withTags(Collection<Tag> tags)` A list of tags that specify information about the stack set.
`StackSet`	`withTags(Tag... tags)` A list of tags that specify information about the stack set.
`StackSet`	`withTemplateBody(String templateBody)` The structure that contains the body of the template that was used to create or update the stack set.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StackSet
```
public StackSet()
```
- Method Detail
  - setStackSetName
```
public void setStackSetName(String stackSetName)
```
    The name that's associated with the stack set.
    
    Parameters:
    
    stackSetName - The name that's associated with the stack set.
  - getStackSetName
```
public String getStackSetName()
```
    The name that's associated with the stack set.
    
    Returns:
    
    The name that's associated with the stack set.
  - withStackSetName
```
public StackSet withStackSetName(String stackSetName)
```
    The name that's associated with the stack set.
    
    Parameters:
    
    stackSetName - The name that's associated with the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStackSetId
```
public void setStackSetId(String stackSetId)
```
    The ID of the stack set.
    
    Parameters:
    
    stackSetId - The ID of the stack set.
  - getStackSetId
```
public String getStackSetId()
```
    The ID of the stack set.
    
    Returns:
    
    The ID of the stack set.
  - withStackSetId
```
public StackSet withStackSetId(String stackSetId)
```
    The ID of the stack set.
    
    Parameters:
    
    stackSetId - The ID of the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the stack set that you specify when the stack set is created or updated.
    
    Parameters:
    
    description - A description of the stack set that you specify when the stack set is created or updated.
  - getDescription
```
public String getDescription()
```
    A description of the stack set that you specify when the stack set is created or updated.
    
    Returns:
    
    A description of the stack set that you specify when the stack set is created or updated.
  - withDescription
```
public StackSet withDescription(String description)
```
    A description of the stack set that you specify when the stack set is created or updated.
    
    Parameters:
    
    description - A description of the stack set that you specify when the stack set is created or updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the stack set.
    
    Parameters:
    
    status - The status of the stack set.
    
    See Also:
    
    StackSetStatus
  - getStatus
```
public String getStatus()
```
    The status of the stack set.
    
    Returns:
    
    The status of the stack set.
    
    See Also:
    
    StackSetStatus
  - withStatus
```
public StackSet withStatus(String status)
```
    The status of the stack set.
    
    Parameters:
    
    status - The status of the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackSetStatus
  - setStatus
```
public void setStatus(StackSetStatus status)
```
    The status of the stack set.
    
    Parameters:
    
    status - The status of the stack set.
    
    See Also:
    
    StackSetStatus
  - withStatus
```
public StackSet withStatus(StackSetStatus status)
```
    The status of the stack set.
    
    Parameters:
    
    status - The status of the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackSetStatus
  - setTemplateBody
```
public void setTemplateBody(String templateBody)
```
    The structure that contains the body of the template that was used to create or update the stack set.
    
    Parameters:
    
    templateBody - The structure that contains the body of the template that was used to create or update the stack set.
  - getTemplateBody
```
public String getTemplateBody()
```
    The structure that contains the body of the template that was used to create or update the stack set.
    
    Returns:
    
    The structure that contains the body of the template that was used to create or update the stack set.
  - withTemplateBody
```
public StackSet withTemplateBody(String templateBody)
```
    The structure that contains the body of the template that was used to create or update the stack set.
    
    Parameters:
    
    templateBody - The structure that contains the body of the template that was used to create or update the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public List<Parameter> getParameters()
```
    A list of input parameters for a stack set.
    
    Returns:
    
    A list of input parameters for a stack set.
  - setParameters
```
public void setParameters(Collection<Parameter> parameters)
```
    A list of input parameters for a stack set.
    
    Parameters:
    
    parameters - A list of input parameters for a stack set.
  - withParameters
```
public StackSet withParameters(Parameter... parameters)
```
    A list of input parameters for a stack set.
    
    NOTE: This method appends the values to the existing list (if any). Use setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parameters - A list of input parameters for a stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParameters
```
public StackSet withParameters(Collection<Parameter> parameters)
```
    A list of input parameters for a stack set.
    
    Parameters:
    
    parameters - A list of input parameters for a stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCapabilities
```
public 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.
    
    Returns:
    
    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:
    
    Capability
  - setCapabilities
```
public void setCapabilities(Collection<String> capabilities)
```
    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.
    
    Parameters:
    
    capabilities - 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:
    
    Capability
  - withCapabilities
```
public StackSet withCapabilities(String... capabilities)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    capabilities - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - withCapabilities
```
public StackSet withCapabilities(Collection<String> capabilities)
```
    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.
    
    Parameters:
    
    capabilities - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - withCapabilities
```
public StackSet withCapabilities(Capability... capabilities)
```
    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.
    
    Parameters:
    
    capabilities - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - getTags
```
public List<Tag> getTags()
```
    A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
    
    Returns:
    
    A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
    
    Parameters:
    
    tags - A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
  - withTags
```
public StackSet withTags(Tag... tags)
```
    A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public StackSet withTags(Collection<Tag> tags)
```
    A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
    
    Parameters:
    
    tags - A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStackSetARN
```
public void setStackSetARN(String stackSetARN)
```
    The Amazon Resource Number (ARN) of the stack set.
    
    Parameters:
    
    stackSetARN - The Amazon Resource Number (ARN) of the stack set.
  - getStackSetARN
```
public String getStackSetARN()
```
    The Amazon Resource Number (ARN) of the stack set.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the stack set.
  - withStackSetARN
```
public StackSet withStackSetARN(String stackSetARN)
```
    The Amazon Resource Number (ARN) of the stack set.
    
    Parameters:
    
    stackSetARN - The Amazon Resource Number (ARN) of the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdministrationRoleARN
```
public void setAdministrationRoleARN(String administrationRoleARN)
```
    The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
    
    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.
    
    Parameters:
    
    administrationRoleARN - The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
    
    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.
  - getAdministrationRoleARN
```
public String getAdministrationRoleARN()
```
    The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
    
    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.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
    
    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.
  - withAdministrationRoleARN
```
public StackSet withAdministrationRoleARN(String administrationRoleARN)
```
    The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
    
    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.
    
    Parameters:
    
    administrationRoleARN - The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRoleName
```
public void setExecutionRoleName(String executionRoleName)
```
    The name of the IAM execution role used to create or update the stack set.
    
    Use customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    Parameters:
    
    executionRoleName - The name of the IAM execution role used to create or update the stack set.
    
    Use customized execution roles to control which stack resources users and groups can include in their stack sets.
  - getExecutionRoleName
```
public String getExecutionRoleName()
```
    The name of the IAM execution role used to create or update the stack set.
    
    Use customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    Returns:
    
    The name of the IAM execution role used to create or update the stack set.
    
    Use customized execution roles to control which stack resources users and groups can include in their stack sets.
  - withExecutionRoleName
```
public StackSet withExecutionRoleName(String executionRoleName)
```
    The name of the IAM execution role used to create or update the stack set.
    
    Use customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    Parameters:
    
    executionRoleName - The name of the IAM execution role used to create or update the stack set.
    
    Use customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StackSet clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class StackSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackSet

Method Detail

setStackSetName

getStackSetName

withStackSetName

setStackSetId

getStackSetId

withStackSetId

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

setStatus

withStatus

setTemplateBody

getTemplateBody

withTemplateBody

getParameters

setParameters

withParameters

withParameters

getCapabilities

setCapabilities

withCapabilities

withCapabilities

withCapabilities

getTags

setTags

withTags

withTags

setStackSetARN

getStackSetARN

withStackSetARN

setAdministrationRoleARN

getAdministrationRoleARN

withAdministrationRoleARN

setExecutionRoleName

getExecutionRoleName

withExecutionRoleName

toString

equals

hashCode

clone