@Generated(value="software.amazon.awssdk:codegen") public class UpdateStackSetRequest extends CloudFormationRequest implements ToCopyableBuilder<UpdateStackSetRequest.Builder,UpdateStackSetRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateStackSetRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateStackSetRequest.Builder |
builder() |
List<Capability> |
capabilities()
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
List<String> |
capabilitiesStrings()
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
String |
description()
A brief description of updates that you are making.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
operationId()
The unique ID for this stack set operation.
|
StackSetOperationPreferences |
operationPreferences()
Preferences for how AWS CloudFormation performs this stack set operation.
|
List<Parameter> |
parameters()
A list of input parameters for the stack set template.
|
static Class<? extends UpdateStackSetRequest.Builder> |
serializableBuilderClass() |
String |
stackSetName()
The name or unique ID of the stack set that you want to update.
|
List<Tag> |
tags()
The key-value pairs to associate with this stack set and the stacks created from it.
|
String |
templateBody()
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
bytes.
|
String |
templateURL()
The location of the file that contains the template body.
|
UpdateStackSetRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
usePreviousTemplate()
Use the existing template that's associated with the stack set that you're updating.
|
requestOverrideConfig
copy
public String stackSetName()
The name or unique ID of the stack set that you want to update.
public String description()
A brief description of updates that you are making.
public 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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
public 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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
public 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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
public List<Parameter> parameters()
A list of input parameters for the stack set template.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Capability> capabilities()
A list of values that you must specify before AWS CloudFormation can create certain stack sets. 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 those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
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 this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
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 this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
public List<String> capabilitiesStrings()
A list of values that you must specify before AWS CloudFormation can create certain stack sets. 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 those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
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 this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
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 this parameter, this action returns an
InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public StackSetOperationPreferences operationPreferences()
Preferences for how AWS CloudFormation performs this stack set operation.
public 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
.
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
.
public UpdateStackSetRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateStackSetRequest.Builder,UpdateStackSetRequest>
toBuilder
in class CloudFormationRequest
public static UpdateStackSetRequest.Builder builder()
public static Class<? extends UpdateStackSetRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.