com.amazonaws.services.cloudformation.model
Class UpdateStackRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.cloudformation.model.UpdateStackRequest

public class UpdateStackRequest
extends AmazonWebServiceRequest

Container for the parameters to the 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 .

See Also:

AmazonCloudFormation.updateStack(UpdateStackRequest)

Constructor Summary

UpdateStackRequest()

Method Summary

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	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	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(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	withTemplateBody(String templateBody) Structure containing the template body.
UpdateStackRequest	withTemplateURL(String templateURL) Location of file containing the template body.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateStackRequest

public UpdateStackRequest()

Method Detail

getStackName

public String getStackName()

The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Returns:

The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

setStackName

public void setStackName(String stackName)

The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Parameters:

stackName - The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

withStackName

public UpdateStackRequest withStackName(String stackName)

The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

stackName - The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateBody

public String getTemplateBody()

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.

Constraints:
Length: 1 -

Returns:

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.

setTemplateBody

public void setTemplateBody(String 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.

Constraints:
Length: 1 -

Parameters:

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.

withTemplateBody

public UpdateStackRequest withTemplateBody(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateURL

public String getTemplateURL()

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.

Constraints:
Length: 1 - 1024

Returns:

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.

setTemplateURL

public void setTemplateURL(String 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.

Constraints:
Length: 1 - 1024

Parameters:

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.

withTemplateURL

public UpdateStackRequest withTemplateURL(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024

Parameters:

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.

Returns:

A reference to this updated 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.

Returns:

A list of Parameter structures that specify input parameters for the stack.

setParameters

public void setParameters(Collection<Parameter> parameters)

A list of Parameter structures that specify input parameters for the stack.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack.

withParameters

public UpdateStackRequest withParameters(Parameter... parameters)

A list of Parameter structures that specify input parameters for the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack.

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

parameters - A list of Parameter structures that specify input parameters for the stack.

Returns:

A reference to this updated object so that method calls can be chained together.

getCapabilities

public List<String> getCapabilities()

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.

Returns:

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.

setCapabilities

public void setCapabilities(Collection<String> 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.

Parameters:

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.

withCapabilities

public UpdateStackRequest withCapabilities(String... 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withCapabilities

public UpdateStackRequest withCapabilities(Collection<String> 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object