UpdateStackSetRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudformation.model.UpdateStackSetRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateStackSetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateStackSetRequest()

Constructors
Constructor and Description
`UpdateStackSetRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateStackSetRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getAccounts()` The accounts in which to update associated stack instances.
`String`	`getAdministrationRoleARN()` The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.
`List<String>`	`getCapabilities()` In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
`String`	`getDescription()` A brief description of updates that you are making.
`String`	`getExecutionRoleName()` The name of the IAM execution role to use to update the stack set.
`String`	`getOperationId()` The unique ID for this stack set operation.
`StackSetOperationPreferences`	`getOperationPreferences()` Preferences for how AWS CloudFormation performs this stack set operation.
`List<Parameter>`	`getParameters()` A list of input parameters for the stack set template.
`List<String>`	`getRegions()` The regions in which to update associated stack instances.
`String`	`getStackSetName()` The name or unique ID of the stack set that you want to update.
`List<Tag>`	`getTags()` The key-value pairs to associate with this stack set and the stacks created from it.
`String`	`getTemplateBody()` The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
`String`	`getTemplateURL()` The location of the file that contains the template body.
`Boolean`	`getUsePreviousTemplate()` Use the existing template that's associated with the stack set that you're updating.
`int`	`hashCode()`
`Boolean`	`isUsePreviousTemplate()` Use the existing template that's associated with the stack set that you're updating.
`void`	`setAccounts(Collection<String> accounts)` The accounts in which to update associated stack instances.
`void`	`setAdministrationRoleARN(String administrationRoleARN)` The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.
`void`	`setCapabilities(Collection<String> capabilities)` In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
`void`	`setDescription(String description)` A brief description of updates that you are making.
`void`	`setExecutionRoleName(String executionRoleName)` The name of the IAM execution role to use to update the stack set.
`void`	`setOperationId(String operationId)` The unique ID for this stack set operation.
`void`	`setOperationPreferences(StackSetOperationPreferences operationPreferences)` Preferences for how AWS CloudFormation performs this stack set operation.
`void`	`setParameters(Collection<Parameter> parameters)` A list of input parameters for the stack set template.
`void`	`setRegions(Collection<String> regions)` The regions in which to update associated stack instances.
`void`	`setStackSetName(String stackSetName)` The name or unique ID of the stack set that you want to update.
`void`	`setTags(Collection<Tag> tags)` The key-value pairs to associate with this stack set and the stacks created from it.
`void`	`setTemplateBody(String templateBody)` The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
`void`	`setTemplateURL(String templateURL)` The location of the file that contains the template body.
`void`	`setUsePreviousTemplate(Boolean usePreviousTemplate)` Use the existing template that's associated with the stack set that you're updating.
`String`	`toString()` Returns a string representation of this object.
`UpdateStackSetRequest`	`withAccounts(Collection<String> accounts)` The accounts in which to update associated stack instances.
`UpdateStackSetRequest`	`withAccounts(String... accounts)` The accounts in which to update associated stack instances.
`UpdateStackSetRequest`	`withAdministrationRoleARN(String administrationRoleARN)` The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.
`UpdateStackSetRequest`	`withCapabilities(Capability... capabilities)` In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
`UpdateStackSetRequest`	`withCapabilities(Collection<String> capabilities)` In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
`UpdateStackSetRequest`	`withCapabilities(String... capabilities)` In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
`UpdateStackSetRequest`	`withDescription(String description)` A brief description of updates that you are making.
`UpdateStackSetRequest`	`withExecutionRoleName(String executionRoleName)` The name of the IAM execution role to use to update the stack set.
`UpdateStackSetRequest`	`withOperationId(String operationId)` The unique ID for this stack set operation.
`UpdateStackSetRequest`	`withOperationPreferences(StackSetOperationPreferences operationPreferences)` Preferences for how AWS CloudFormation performs this stack set operation.
`UpdateStackSetRequest`	`withParameters(Collection<Parameter> parameters)` A list of input parameters for the stack set template.
`UpdateStackSetRequest`	`withParameters(Parameter... parameters)` A list of input parameters for the stack set template.
`UpdateStackSetRequest`	`withRegions(Collection<String> regions)` The regions in which to update associated stack instances.
`UpdateStackSetRequest`	`withRegions(String... regions)` The regions in which to update associated stack instances.
`UpdateStackSetRequest`	`withStackSetName(String stackSetName)` The name or unique ID of the stack set that you want to update.
`UpdateStackSetRequest`	`withTags(Collection<Tag> tags)` The key-value pairs to associate with this stack set and the stacks created from it.
`UpdateStackSetRequest`	`withTags(Tag... tags)` The key-value pairs to associate with this stack set and the stacks created from it.
`UpdateStackSetRequest`	`withTemplateBody(String templateBody)` The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
`UpdateStackSetRequest`	`withTemplateURL(String templateURL)` The location of the file that contains the template body.
`UpdateStackSetRequest`	`withUsePreviousTemplate(Boolean usePreviousTemplate)` Use the existing template that's associated with the stack set that you're updating.

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

- Constructor Detail
  - UpdateStackSetRequest
```
public UpdateStackSetRequest()
```
- Method Detail
  - setStackSetName
```
public void setStackSetName(String stackSetName)
```
    The name or unique ID of the stack set that you want to update.
    
    Parameters:
    
    stackSetName - The name or unique ID of the stack set that you want to update.
  - getStackSetName
```
public String getStackSetName()
```
    The name or unique ID of the stack set that you want to update.
    
    Returns:
    
    The name or unique ID of the stack set that you want to update.
  - withStackSetName
```
public UpdateStackSetRequest withStackSetName(String stackSetName)
```
    The name or unique ID of the stack set that you want to update.
    
    Parameters:
    
    stackSetName - The name or unique ID of the stack set that you want to update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A brief description of updates that you are making.
    
    Parameters:
    
    description - A brief description of updates that you are making.
  - getDescription
```
public String getDescription()
```
    A brief description of updates that you are making.
    
    Returns:
    
    A brief description of updates that you are making.
  - withDescription
```
public UpdateStackSetRequest withDescription(String description)
```
    A brief description of updates that you are making.
    
    Parameters:
    
    description - A brief description of updates that you are making.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateBody
```
public void setTemplateBody(String templateBody)
```
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Parameters:
    
    templateBody - The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - getTemplateBody
```
public String getTemplateBody()
```
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - withTemplateBody
```
public UpdateStackSetRequest withTemplateBody(String templateBody)
```
    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Parameters:
    
    templateBody - The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateURL
```
public void setTemplateURL(String templateURL)
```
    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Parameters:
    
    templateURL - The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - getTemplateURL
```
public String getTemplateURL()
```
    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - withTemplateURL
```
public UpdateStackSetRequest withTemplateURL(String templateURL)
```
    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Parameters:
    
    templateURL - The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsePreviousTemplate
```
public void setUsePreviousTemplate(Boolean usePreviousTemplate)
```
    Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Parameters:
    
    usePreviousTemplate - Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - getUsePreviousTemplate
```
public Boolean getUsePreviousTemplate()
```
    Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - withUsePreviousTemplate
```
public UpdateStackSetRequest withUsePreviousTemplate(Boolean usePreviousTemplate)
```
    Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Parameters:
    
    usePreviousTemplate - Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUsePreviousTemplate
```
public Boolean isUsePreviousTemplate()
```
    Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
    
    Returns:
    
    Use the existing template that's associated with the stack set that you're updating.
    
    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
  - getParameters
```
public List<Parameter> getParameters()
```
    A list of input parameters for the stack set template.
    
    Returns:
    
    A list of input parameters for the stack set template.
  - setParameters
```
public void setParameters(Collection<Parameter> parameters)
```
    A list of input parameters for the stack set template.
    
    Parameters:
    
    parameters - A list of input parameters for the stack set template.
  - withParameters
```
public UpdateStackSetRequest withParameters(Parameter... parameters)
```
    A list of input parameters for the stack set template.
    
    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 the stack set template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParameters
```
public UpdateStackSetRequest withParameters(Collection<Parameter> parameters)
```
    A list of input parameters for the stack set template.
    
    Parameters:
    
    parameters - A list of input parameters for the stack set template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCapabilities
```
public List<String> getCapabilities()
```
    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
      
      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
      
      If you have IAM resources, you can specify either capability.
      
      If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      
      If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
      
      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    - CAPABILITY_AUTO_EXPAND
      
      Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
      
      Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Returns:
    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
    
    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
    
    If you have IAM resources, you can specify either capability.
    
    If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
    
    If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
    
    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    CAPABILITY_AUTO_EXPAND
    
    Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    
    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    See Also:
    
    Capability
  - setCapabilities
```
public void setCapabilities(Collection<String> capabilities)
```
    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
      
      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
      
      If you have IAM resources, you can specify either capability.
      
      If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      
      If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
      
      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    - CAPABILITY_AUTO_EXPAND
      
      Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
      
      Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Parameters:
    capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
    
    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
    
    If you have IAM resources, you can specify either capability.
    
    If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
    
    If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
    
    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    CAPABILITY_AUTO_EXPAND
    
    Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    
    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    See Also:
    
    Capability
  - withCapabilities
```
public UpdateStackSetRequest withCapabilities(String... capabilities)
```
    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
      
      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
      
      If you have IAM resources, you can specify either capability.
      
      If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      
      If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
      
      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    - CAPABILITY_AUTO_EXPAND
      
      Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
      
      Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    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 - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
    
    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
    
    If you have IAM resources, you can specify either capability.
    
    If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
    
    If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
    
    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    CAPABILITY_AUTO_EXPAND
    
    Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    
    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - withCapabilities
```
public UpdateStackSetRequest withCapabilities(Collection<String> capabilities)
```
    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
      
      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
      
      If you have IAM resources, you can specify either capability.
      
      If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      
      If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
      
      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    - CAPABILITY_AUTO_EXPAND
      
      Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
      
      Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Parameters:
    capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
    
    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
    
    If you have IAM resources, you can specify either capability.
    
    If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
    
    If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
    
    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    CAPABILITY_AUTO_EXPAND
    
    Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    
    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - withCapabilities
```
public UpdateStackSetRequest withCapabilities(Capability... capabilities)
```
    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    - CAPABILITY_IAM and CAPABILITY_NAMED_IAM
      
      Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
      
      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
      
      If you have IAM resources, you can specify either capability.
      
      If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      
      If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
      
      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
      
      AWS::IAM::AccessKey
      
      AWS::IAM::Group
      
      AWS::IAM::InstanceProfile
      
      AWS::IAM::Policy
      
      AWS::IAM::Role
      
      AWS::IAM::User
      
      AWS::IAM::UserToGroupAddition
      
      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    - CAPABILITY_AUTO_EXPAND
      
      Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
      
      Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Parameters:
    capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
    
    CAPABILITY_IAM and CAPABILITY_NAMED_IAM
    
    Some stack 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 those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
    
    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
    
    If you have IAM resources, you can specify either capability.
    
    If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
    
    If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
    
    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
    
    AWS::IAM::AccessKey
    
    AWS::IAM::Group
    
    AWS::IAM::InstanceProfile
    
    AWS::IAM::Policy
    
    AWS::IAM::Role
    
    AWS::IAM::User
    
    AWS::IAM::UserToGroupAddition
    
    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    CAPABILITY_AUTO_EXPAND
    
    Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
    
    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - getTags
```
public List<Tag> getTags()
```
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    - If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    - If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    - If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
    Returns:
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    
    If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    
    If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    
    If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    - If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    - If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    - If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
    Parameters:
    tags - The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    
    If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    
    If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    
    If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
  - withTags
```
public UpdateStackSetRequest withTags(Tag... tags)
```
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    - If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    - If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    - If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
    
    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 - The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    
    If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    
    If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    
    If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public UpdateStackSetRequest withTags(Collection<Tag> tags)
```
    The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    - If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    - If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    - If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
    Parameters:
    tags - The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
    
    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
    
    If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
    
    If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
    
    If you specify an empty value, AWS CloudFormation removes all currently associated tags.
    
    If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperationPreferences
```
public void setOperationPreferences(StackSetOperationPreferences operationPreferences)
```
    Preferences for how AWS CloudFormation performs this stack set operation.
    
    Parameters:
    
    operationPreferences - Preferences for how AWS CloudFormation performs this stack set operation.
  - getOperationPreferences
```
public StackSetOperationPreferences getOperationPreferences()
```
    Preferences for how AWS CloudFormation performs this stack set operation.
    
    Returns:
    
    Preferences for how AWS CloudFormation performs this stack set operation.
  - withOperationPreferences
```
public UpdateStackSetRequest withOperationPreferences(StackSetOperationPreferences operationPreferences)
```
    Preferences for how AWS CloudFormation performs this stack set operation.
    
    Parameters:
    
    operationPreferences - Preferences for how AWS CloudFormation performs this stack set operation.
    
    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 to use to update 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. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
    
    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
    
    Parameters:
    
    administrationRoleARN - The Amazon Resource Number (ARN) of the IAM role to use to update 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. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
    
    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
  - getAdministrationRoleARN
```
public String getAdministrationRoleARN()
```
    The Amazon Resource Number (ARN) of the IAM role to use to update 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. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
    
    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the IAM role to use to update 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. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
    
    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
  - withAdministrationRoleARN
```
public UpdateStackSetRequest withAdministrationRoleARN(String administrationRoleARN)
```
    The Amazon Resource Number (ARN) of the IAM role to use to update 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. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
    
    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
    
    Parameters:
    
    administrationRoleARN - The Amazon Resource Number (ARN) of the IAM role to use to update 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. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
    
    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
    
    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 to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    
    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
    
    Parameters:
    
    executionRoleName - The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    
    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
  - getExecutionRoleName
```
public String getExecutionRoleName()
```
    The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    
    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
    
    Returns:
    
    The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    
    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
  - withExecutionRoleName
```
public UpdateStackSetRequest withExecutionRoleName(String executionRoleName)
```
    The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    
    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
    
    Parameters:
    
    executionRoleName - The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
    
    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
    
    If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperationId
```
public void setOperationId(String operationId)
```
    The unique ID for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
    
    If you don't specify an operation ID, AWS CloudFormation generates one automatically.
    
    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
    
    Parameters:
    
    operationId - The unique ID for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
    
    If you don't specify an operation ID, AWS CloudFormation generates one automatically.
    
    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
  - getOperationId
```
public String getOperationId()
```
    The unique ID for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
    
    If you don't specify an operation ID, AWS CloudFormation generates one automatically.
    
    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
    
    Returns:
    
    The unique ID for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
    
    If you don't specify an operation ID, AWS CloudFormation generates one automatically.
    
    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
  - withOperationId
```
public UpdateStackSetRequest withOperationId(String operationId)
```
    The unique ID for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
    
    If you don't specify an operation ID, AWS CloudFormation generates one automatically.
    
    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
    
    Parameters:
    
    operationId - The unique ID for this stack set operation.
    
    The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
    
    If you don't specify an operation ID, AWS CloudFormation generates one automatically.
    
    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAccounts
```
public List<String> getAccounts()
```
    The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Returns:
    
    The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
  - setAccounts
```
public void setAccounts(Collection<String> accounts)
```
    The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Parameters:
    
    accounts - The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
  - withAccounts
```
public UpdateStackSetRequest withAccounts(String... accounts)
```
    The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    NOTE: This method appends the values to the existing list (if any). Use setAccounts(java.util.Collection) or withAccounts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    accounts - The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAccounts
```
public UpdateStackSetRequest withAccounts(Collection<String> accounts)
```
    The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Parameters:
    
    accounts - The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRegions
```
public List<String> getRegions()
```
    The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Returns:
    
    The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
  - setRegions
```
public void setRegions(Collection<String> regions)
```
    The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Parameters:
    
    regions - The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
  - withRegions
```
public UpdateStackSetRequest withRegions(String... regions)
```
    The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    NOTE: This method appends the values to the existing list (if any). Use setRegions(java.util.Collection) or withRegions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    regions - The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRegions
```
public UpdateStackSetRequest withRegions(Collection<String> regions)
```
    The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    Parameters:
    
    regions - The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.
    
    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
    
    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 UpdateStackSetRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class UpdateStackSetRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateStackSetRequest

Method Detail

setStackSetName

getStackSetName

withStackSetName

setDescription

getDescription

withDescription

setTemplateBody

getTemplateBody

withTemplateBody

setTemplateURL

getTemplateURL

withTemplateURL

setUsePreviousTemplate

getUsePreviousTemplate

withUsePreviousTemplate

isUsePreviousTemplate

getParameters

setParameters

withParameters

withParameters

getCapabilities

setCapabilities

withCapabilities

withCapabilities

withCapabilities

getTags

setTags

withTags

withTags

setOperationPreferences

getOperationPreferences

withOperationPreferences

setAdministrationRoleARN

getAdministrationRoleARN

withAdministrationRoleARN

setExecutionRoleName

getExecutionRoleName

withExecutionRoleName

setOperationId

getOperationId

withOperationId

getAccounts

setAccounts

withAccounts

withAccounts

getRegions

setRegions

withRegions

withRegions

toString

equals

hashCode

clone