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.
Note: You cannot update AWS::S3::Bucket resources, for example, to add or modify tags.
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 .
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<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 the updated 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.
|
String |
getTemplateURL()
Location of file containing the template body.
|
int |
hashCode() |
void |
setCapabilities(Collection<String> capabilities)
The list of capabilities that you want to allow in 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 the updated 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.
|
void |
setTemplateURL(String templateURL)
Location of file containing the template body.
|
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 |
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 the updated 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.
|
UpdateStackRequest |
withTemplateURL(String templateURL)
Location of file containing the template body.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, 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 pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 -
Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
public void setTemplateBody(String templateBody)
Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 -
templateBody
- Structure containing the template body. (For more information, go to
the AWS
CloudFormation User Guide.) Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
public UpdateStackRequest withTemplateBody(String templateBody)
Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
templateBody
- Structure containing the template body. (For more information, go to
the AWS
CloudFormation User Guide.) Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
public String getTemplateURL()
Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 - 1024
Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
public void setTemplateURL(String templateURL)
Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
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 the AWS
CloudFormation User Guide. Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
public UpdateStackRequest withTemplateURL(String templateURL)
Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
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 the AWS
CloudFormation User Guide. Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
public String getStackPolicyDuringUpdateBody()
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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 associated with the stack will be used.
Constraints:
Length: 1 - 16384
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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 associated with the stack will be used.
public void setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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 associated with the stack will be used.
Constraints:
Length: 1 - 16384
stackPolicyDuringUpdateBody
- Structure containing the temporary overriding stack policy body. If
you pass StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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 associated with the stack will be used.
public UpdateStackRequest withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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 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. If
you pass StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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 associated with the stack will be used.
public String getStackPolicyDuringUpdateURL()
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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. If you pass
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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. If you pass
StackPolicyDuringUpdateBody
and
StackPolicyDuringUpdateURL
, only
StackPolicyDuringUpdateBody
is used. 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
and StackPolicyURL
, only
StackPolicyBody
is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and StackPolicyURL
, only
StackPolicyBody
is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and StackPolicyURL
, only
StackPolicyBody
is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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 the updated stack policy body. If you pass
StackPolicyBody
and StackPolicyURL
, only
StackPolicyBody
is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and StackPolicyURL
, only
StackPolicyBody
is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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 the updated stack policy body. If you pass
StackPolicyBody
and StackPolicyURL
, only
StackPolicyBody
is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and
StackPolicyURL
, only StackPolicyBody
is
used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and
StackPolicyURL
, only StackPolicyBody
is
used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and
StackPolicyURL
, only StackPolicyBody
is
used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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. If you pass StackPolicyBody
and
StackPolicyURL
, only StackPolicyBody
is
used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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
and
StackPolicyURL
, only StackPolicyBody
is
used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the 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. If you pass StackPolicyBody
and
StackPolicyURL
, only StackPolicyBody
is
used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.