@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateStackSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateStackSetRequest() |
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> |
getCapabilities()
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
String |
getDescription()
A brief description of updates that you are making.
|
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.
|
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 |
setCapabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
void |
setDescription(String description)
A brief description of updates that you are making.
|
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 |
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; useful for testing and debugging.
|
UpdateStackSetRequest |
withCapabilities(Capability... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest |
withCapabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest |
withCapabilities(String... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest |
withDescription(String description)
A brief description of updates that you are making.
|
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 |
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setStackSetName(String stackSetName)
The name or unique ID of the stack set that you want to update.
stackSetName
- The name or unique ID of the stack set that you want to update.public String getStackSetName()
The name or unique ID of the stack set that you want to update.
public UpdateStackSetRequest withStackSetName(String stackSetName)
The name or unique ID of the stack set that you want to update.
stackSetName
- The name or unique ID of the stack set that you want to update.public void setDescription(String description)
A brief description of updates that you are making.
description
- A brief description of updates that you are making.public String getDescription()
A brief description of updates that you are making.
public UpdateStackSetRequest withDescription(String description)
A brief description of updates that you are making.
description
- A brief description of updates that you are making.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.
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.
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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
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.
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.
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.
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.
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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
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.
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.
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.
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.
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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
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.
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.
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.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
public List<Parameter> getParameters()
A list of input parameters for the stack set template.
public void setParameters(Collection<Parameter> parameters)
A list of input parameters for the stack set template.
parameters
- A list of input parameters for the stack set template.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
- A list of input parameters for the stack set template.public UpdateStackSetRequest withParameters(Collection<Parameter> parameters)
A list of input parameters for the stack set template.
parameters
- A list of input parameters for the stack set template.public List<String> getCapabilities()
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.
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.
Capability
public void setCapabilities(Collection<String> 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.
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.
Capability
public UpdateStackSetRequest withCapabilities(String... 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.
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.
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.
Capability
public UpdateStackSetRequest withCapabilities(Collection<String> 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.
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.
Capability
public UpdateStackSetRequest withCapabilities(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.
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.
Capability
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.
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 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.
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.
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.
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.
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.
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.
public void setOperationPreferences(StackSetOperationPreferences operationPreferences)
Preferences for how AWS CloudFormation performs this stack set operation.
operationPreferences
- Preferences for how AWS CloudFormation performs this stack set operation.public StackSetOperationPreferences getOperationPreferences()
Preferences for how AWS CloudFormation performs this stack set operation.
public UpdateStackSetRequest withOperationPreferences(StackSetOperationPreferences operationPreferences)
Preferences for how AWS CloudFormation performs this stack set operation.
operationPreferences
- Preferences for how AWS CloudFormation performs this stack set operation.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
.
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
.
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
.
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 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
.
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
.
public String toString()
toString
in class Object
Object.toString()
public UpdateStackSetRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.