public class UpdateStackRequest extends AmazonWebServiceRequest implements Serializable
UpdateStack operation
.
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
Tags that were associated with this stack during creation time will
still be associated with the stack after an UpdateStack
operation.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack .
NOOP
Constructor and Description |
---|
UpdateStackRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
List<String> |
getCapabilities()
The list of capabilities that you want to allow in the stack.
|
List<String> |
getNotificationARNs()
Update the ARNs for the Amazon SNS topics that are associated with the
stack.
|
List<Parameter> |
getParameters()
A list of
Parameter structures that specify input
parameters for the stack. |
String |
getStackName()
The name or 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.
|
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)
The list of capabilities that you want to allow in the stack.
|
void |
setNotificationARNs(Collection<String> notificationARNs)
Update the ARNs for the Amazon SNS topics that are associated with the
stack.
|
void |
setParameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input
parameters for the stack. |
void |
setStackName(String stackName)
The name or 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 |
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)
The list of capabilities that you want to allow in the stack.
|
UpdateStackRequest |
withCapabilities(Collection<String> capabilities)
The list of capabilities that you want to allow in the stack.
|
UpdateStackRequest |
withCapabilities(String... capabilities)
The list of capabilities that you want to allow in the stack.
|
UpdateStackRequest |
withNotificationARNs(Collection<String> notificationARNs)
Update the ARNs for the Amazon SNS topics that are associated with the
stack.
|
UpdateStackRequest |
withNotificationARNs(String... notificationARNs)
Update the ARNs for the Amazon SNS topics that are associated with the
stack.
|
UpdateStackRequest |
withParameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input
parameters for the stack. |
UpdateStackRequest |
withParameters(Parameter... parameters)
A list of
Parameter structures that specify input
parameters for the stack. |
UpdateStackRequest |
withStackName(String stackName)
The name or 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 |
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.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getStackName()
public void setStackName(String stackName)
stackName
- The name or stack ID of the stack to update. public UpdateStackRequest withStackName(String stackName)
Returns a reference to this object so that method calls can be chained together.
stackName
- The name or stack ID of the stack to update. public String getTemplateBody()
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 -
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public void setTemplateBody(String templateBody)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 -
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 the
TemplateURL
parameter, but not both.
public UpdateStackRequest withTemplateBody(String templateBody)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
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 the
TemplateURL
parameter, but not both.
public String getTemplateURL()
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 - 1024
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public void setTemplateURL(String templateURL)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 - 1024
templateURL
- Location of file containing the template body. The URL must point to a
template located in an S3 bucket in the same region as the stack. For
more information, go to Template
Anatomy in the AWS CloudFormation User Guide. Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public UpdateStackRequest withTemplateURL(String templateURL)
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
templateURL
- Location of file containing the template body. The URL must point to a
template located in an S3 bucket in the same region as the stack. For
more information, go to Template
Anatomy in the AWS CloudFormation User Guide. Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
public Boolean isUsePreviousTemplate()
public void setUsePreviousTemplate(Boolean usePreviousTemplate)
usePreviousTemplate
- Reuse the existing template that is associated with the stack that you
are updating.public UpdateStackRequest withUsePreviousTemplate(Boolean usePreviousTemplate)
Returns a reference to this object so that method calls can be chained together.
usePreviousTemplate
- Reuse the existing template that is associated with the stack that you
are updating.public Boolean getUsePreviousTemplate()
public String getStackPolicyDuringUpdateBody()
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
Constraints:
Length: 1 - 16384
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
public void setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
Constraints:
Length: 1 - 16384
stackPolicyDuringUpdateBody
- Structure containing the temporary overriding stack policy body. You
can specify either the StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
public UpdateStackRequest withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 16384
stackPolicyDuringUpdateBody
- Structure containing the temporary overriding stack policy body. You
can specify either the StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
public String getStackPolicyDuringUpdateURL()
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
Constraints:
Length: 1 - 1350
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
public void setStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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.
Constraints:
Length: 1 - 1350
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 the
StackPolicyDuringUpdateURL
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.
public UpdateStackRequest withStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1350
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 the
StackPolicyDuringUpdateURL
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.
public List<Parameter> getParameters()
Parameter
structures that specify input
parameters for the stack.Parameter
structures that specify input
parameters for the stack.public void setParameters(Collection<Parameter> parameters)
Parameter
structures that specify input
parameters for the stack.parameters
- A list of Parameter
structures that specify input
parameters for the stack.public UpdateStackRequest withParameters(Parameter... parameters)
Parameter
structures that specify input
parameters for the stack.
Returns a reference to this object so that method calls can be chained together.
parameters
- A list of Parameter
structures that specify input
parameters for the stack.public UpdateStackRequest withParameters(Collection<Parameter> parameters)
Parameter
structures that specify input
parameters for the stack.
Returns a reference to this object so that method calls can be chained together.
parameters
- A list of Parameter
structures that specify input
parameters for the stack.public List<String> getCapabilities()
public void setCapabilities(Collection<String> capabilities)
capabilities
- The list of capabilities that you want to allow in the stack. If your
stack contains IAM resources, you must specify the CAPABILITY_IAM
value for this parameter; otherwise, this action returns an
InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::Policy,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public UpdateStackRequest withCapabilities(String... capabilities)
Returns a reference to this object so that method calls can be chained together.
capabilities
- The list of capabilities that you want to allow in the stack. If your
stack contains IAM resources, you must specify the CAPABILITY_IAM
value for this parameter; otherwise, this action returns an
InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::Policy,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public UpdateStackRequest withCapabilities(Collection<String> capabilities)
Returns a reference to this object so that method calls can be chained together.
capabilities
- The list of capabilities that you want to allow in the stack. If your
stack contains IAM resources, you must specify the CAPABILITY_IAM
value for this parameter; otherwise, this action returns an
InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::Policy,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public UpdateStackRequest withCapabilities(Capability... capabilities)
Returns a reference to this object so that method calls can be chained together.
capabilities
- The list of capabilities that you want to allow in the stack. If your
stack contains IAM resources, you must specify the CAPABILITY_IAM
value for this parameter; otherwise, this action returns an
InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::Policy,
AWS::IAM::User,
and AWS::IAM::UserToGroupAddition.public String getStackPolicyBody()
StackPolicyBody
or the StackPolicyURL
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.
Constraints:
Length: 1 - 16384
StackPolicyBody
or the StackPolicyURL
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.
public void setStackPolicyBody(String stackPolicyBody)
StackPolicyBody
or the StackPolicyURL
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.
Constraints:
Length: 1 - 16384
stackPolicyBody
- Structure containing a new stack policy body. You can specify either
the StackPolicyBody
or the StackPolicyURL
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.
public UpdateStackRequest withStackPolicyBody(String stackPolicyBody)
StackPolicyBody
or the StackPolicyURL
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 16384
stackPolicyBody
- Structure containing a new stack policy body. You can specify either
the StackPolicyBody
or the StackPolicyURL
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.
public String getStackPolicyURL()
StackPolicyBody
or the StackPolicyURL
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.
Constraints:
Length: 1 - 1350
StackPolicyBody
or the StackPolicyURL
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.
public void setStackPolicyURL(String stackPolicyURL)
StackPolicyBody
or the StackPolicyURL
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.
Constraints:
Length: 1 - 1350
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 the StackPolicyURL
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.
public UpdateStackRequest withStackPolicyURL(String stackPolicyURL)
StackPolicyBody
or the StackPolicyURL
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1350
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 the StackPolicyURL
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.
public List<String> getNotificationARNs()
Constraints:
Length: 0 - 5
public void setNotificationARNs(Collection<String> notificationARNs)
Constraints:
Length: 0 - 5
notificationARNs
- Update the ARNs for the Amazon SNS topics that are associated with the
stack.public UpdateStackRequest withNotificationARNs(String... notificationARNs)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
notificationARNs
- Update the ARNs for the Amazon SNS topics that are associated with the
stack.public UpdateStackRequest withNotificationARNs(Collection<String> notificationARNs)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
notificationARNs
- Update the ARNs for the Amazon SNS topics that are associated with the
stack.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.