Class UpdateStackRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudformation.model.UpdateStackRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class UpdateStackRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for an UpdateStack action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description UpdateStackRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateStackRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<String>
getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.List<String>
getNotificationARNs()
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.List<Parameter>
getParameters()
A list ofParameter
structures that specify input parameters for the stack.List<String>
getResourceTypes()
The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.String
getStackName()
The name or unique stack ID of the stack to update.String
getStackPolicyBody()
Structure containing a new stack policy body.String
getStackPolicyDuringUpdateBody()
Structure containing the temporary overriding stack policy body.String
getStackPolicyDuringUpdateURL()
Location of a file containing the temporary overriding stack policy.String
getStackPolicyURL()
Location of a file containing the updated stack policy.List<Tag>
getTags()
Key-value pairs to associate with this stack.String
getTemplateBody()
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.String
getTemplateURL()
Location of file containing the template body.Boolean
getUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.int
hashCode()
Boolean
isUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.void
setCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.void
setNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.void
setParameters(Collection<Parameter> parameters)
A list ofParameter
structures that specify input parameters for the stack.void
setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.void
setStackName(String stackName)
The name or unique stack ID of the stack to update.void
setStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body.void
setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body.void
setStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy.void
setStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy.void
setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.void
setTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.void
setTemplateURL(String templateURL)
Location of file containing the template body.void
setUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.String
toString()
Returns a string representation of this object; useful for testing and debugging.UpdateStackRequest
withCapabilities(Capability... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.UpdateStackRequest
withCapabilities(String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.UpdateStackRequest
withCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks.UpdateStackRequest
withNotificationARNs(String... notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.UpdateStackRequest
withNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack.UpdateStackRequest
withParameters(Parameter... parameters)
A list ofParameter
structures that specify input parameters for the stack.UpdateStackRequest
withParameters(Collection<Parameter> parameters)
A list ofParameter
structures that specify input parameters for the stack.UpdateStackRequest
withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.UpdateStackRequest
withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.UpdateStackRequest
withStackName(String stackName)
The name or unique stack ID of the stack to update.UpdateStackRequest
withStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body.UpdateStackRequest
withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body.UpdateStackRequest
withStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy.UpdateStackRequest
withStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy.UpdateStackRequest
withTags(Tag... tags)
Key-value pairs to associate with this stack.UpdateStackRequest
withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.UpdateStackRequest
withTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.UpdateStackRequest
withTemplateURL(String templateURL)
Location of file containing the template body.UpdateStackRequest
withUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setStackName
public void setStackName(String stackName)
The name or unique stack ID of the stack to update.
- Parameters:
stackName
- The name or unique stack ID of the stack to update.
-
getStackName
public String getStackName()
The name or unique stack ID of the stack to update.
- Returns:
- The name or unique stack ID of the stack to update.
-
withStackName
public UpdateStackRequest withStackName(String stackName)
The name or unique stack ID of the stack to update.
- Parameters:
stackName
- The name or unique stack ID of the stack to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateBody
public void setTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Parameters:
templateBody
- Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.
-
getTemplateBody
public String getTemplateBody()
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Returns:
- Structure containing the template body with a minimum length of 1
byte and a maximum length of 51,200 bytes. (For more information,
go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.
-
withTemplateBody
public UpdateStackRequest withTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Parameters:
templateBody
- Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateURL
public void setTemplateURL(String templateURL)
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Parameters:
templateURL
- Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.
-
getTemplateURL
public String getTemplateURL()
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Returns:
- Location of file containing the template body. The URL must point
to a template that is located in an Amazon S3 bucket. For more
information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.
-
withTemplateURL
public UpdateStackRequest withTemplateURL(String templateURL)
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Parameters:
templateURL
- Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.Conditional: You must specify either the
TemplateBody
or theTemplateURL
parameter, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUsePreviousTemplate
public void setUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
- Parameters:
usePreviousTemplate
- Reuse the existing template that is associated with the stack that you are updating.
-
getUsePreviousTemplate
public Boolean getUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.
- Returns:
- Reuse the existing template that is associated with the stack that you are updating.
-
withUsePreviousTemplate
public UpdateStackRequest withUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
- Parameters:
usePreviousTemplate
- Reuse the existing template that is associated with the stack that you are updating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isUsePreviousTemplate
public Boolean isUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.
- Returns:
- Reuse the existing template that is associated with the stack that you are updating.
-
setStackPolicyDuringUpdateBody
public void setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Parameters:
stackPolicyDuringUpdateBody
- Structure containing the temporary overriding stack policy body. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
-
getStackPolicyDuringUpdateBody
public String getStackPolicyDuringUpdateBody()
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Returns:
- Structure containing the temporary overriding stack policy body.
You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
-
withStackPolicyDuringUpdateBody
public UpdateStackRequest withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Parameters:
stackPolicyDuringUpdateBody
- Structure containing the temporary overriding stack policy body. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackPolicyDuringUpdateURL
public void setStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Parameters:
stackPolicyDuringUpdateURL
- Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
-
getStackPolicyDuringUpdateURL
public String getStackPolicyDuringUpdateURL()
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Returns:
- Location of a file containing the temporary overriding stack
policy. The URL must point to a policy (max size: 16KB) located
in an S3 bucket in the same region as the stack. You can specify
either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
-
withStackPolicyDuringUpdateURL
public UpdateStackRequest withStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Parameters:
stackPolicyDuringUpdateURL
- Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either theStackPolicyDuringUpdateBody
or theStackPolicyDuringUpdateURL
parameter, but not both.If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getParameters
public List<Parameter> getParameters()
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
-
setParameters
public void setParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
-
withParameters
public UpdateStackRequest withParameters(Parameter... parameters)
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.NOTE: This method appends the values to the existing list (if any). Use
setParameters(java.util.Collection)
orwithParameters(java.util.Collection)
if you want to override the existing values.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withParameters
public UpdateStackRequest withParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCapabilities
public List<String> getCapabilities()
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- A list of capabilities that you must specify before AWS
CloudFormation can update certain stacks. 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, you must explicitly
acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error. - See Also:
Capability
-
setCapabilities
public void setCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- See Also:
Capability
-
withCapabilities
public UpdateStackRequest withCapabilities(String... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.NOTE: This method appends the values to the existing list (if any). Use
setCapabilities(java.util.Collection)
orwithCapabilities(java.util.Collection)
if you want to override the existing values.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public UpdateStackRequest withCapabilities(Collection<String> capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public UpdateStackRequest withCapabilities(Capability... capabilities)
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Parameters:
capabilities
- A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. 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, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns anInsufficientCapabilities
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
getResourceTypes
public List<String> getResourceTypes()
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
- Returns:
- The template resource types that you have permissions to work
with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
-
setResourceTypes
public void setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
-
withResourceTypes
public UpdateStackRequest withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
NOTE: This method appends the values to the existing list (if any). Use
setResourceTypes(java.util.Collection)
orwithResourceTypes(java.util.Collection)
if you want to override the existing values.- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withResourceTypes
public UpdateStackRequest withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
- Parameters:
resourceTypes
- The template resource types that you have permissions to work with for this update stack action, such asAWS::EC2::Instance
,AWS::EC2::*
, orCustom::MyCustomInstance
.If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackPolicyBody
public void setStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Parameters:
stackPolicyBody
- Structure containing a new stack policy body. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
-
getStackPolicyBody
public String getStackPolicyBody()
Structure containing a new stack policy body. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Returns:
- Structure containing a new stack policy body. You can specify
either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
-
withStackPolicyBody
public UpdateStackRequest withStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Parameters:
stackPolicyBody
- Structure containing a new stack policy body. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackPolicyURL
public void setStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Parameters:
stackPolicyURL
- Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
-
getStackPolicyURL
public String getStackPolicyURL()
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Returns:
- Location of a file containing the updated stack policy. The URL
must point to a policy (max size: 16KB) located in an S3 bucket
in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
-
withStackPolicyURL
public UpdateStackRequest withStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
StackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Parameters:
stackPolicyURL
- Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either theStackPolicyBody
or theStackPolicyURL
parameter, but not both.You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getNotificationARNs
public List<String> getNotificationARNs()
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
- Returns:
- Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
-
setNotificationARNs
public void setNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
- Parameters:
notificationARNs
- Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
-
withNotificationARNs
public UpdateStackRequest withNotificationARNs(String... notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
NOTE: This method appends the values to the existing list (if any). Use
setNotificationARNs(java.util.Collection)
orwithNotificationARNs(java.util.Collection)
if you want to override the existing values.- Parameters:
notificationARNs
- Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withNotificationARNs
public UpdateStackRequest withNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
- Parameters:
notificationARNs
- Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
public List<Tag> getTags()
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
- Returns:
- Key-value pairs to associate with this stack. AWS CloudFormation
also propagates these tags to supported resources in the stack.
You can specify a maximum number of 10 tags.
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
-
setTags
public void setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
-
withTags
public UpdateStackRequest withTags(Tag... tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public UpdateStackRequest withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public UpdateStackRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-