UpdateStack - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateStack

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 through the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Capabilities.member.N

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for Amazon CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Amazon Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, Amazon CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in Amazon CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by Amazon CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    Important

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without Amazon CloudFormation being notified.

    For more information, see Using Amazon CloudFormation Macros to Perform Custom Processing on Templates.

Note

Only one of the Capabilities and ResourceType parameters can be specified.

Type: Array of strings

Valid Values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND

Required: No

ClientRequestToken

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that Amazon CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that Amazon CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

DisableRollback

Preserve the state of previously provisioned resources when an operation fails.

Default: False

Type: Boolean

Required: No

NotificationARNs.member.N

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that Amazon CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

Type: Array of strings

Array Members: Maximum number of 5 items.

Required: No

Parameters.member.N

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

Type: Array of Parameter objects

Required: No

ResourceTypes.member.N

The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, Amazon CloudFormation grants permissions to all resource types. Amazon Identity and Access Management (IAM) uses this parameter for Amazon CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Amazon Identity and Access Management.

Note

Only one of the Capabilities and ResourceType parameters can be specified.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

RetainExceptOnCreate

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

Type: Boolean

Required: No

RoleARN

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that Amazon CloudFormation assumes to update the stack. Amazon CloudFormation uses the role's credentials to make calls on your behalf. Amazon CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, Amazon CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, Amazon CloudFormation uses the role that was previously associated with the stack. If no role is available, Amazon CloudFormation uses a temporary session that is generated from your user credentials.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

RollbackConfiguration

The rollback triggers for Amazon CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Type: RollbackConfiguration object

Required: No

StackName

The name or unique stack ID of the stack to update.

Type: String

Required: Yes

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 don't specify a stack policy, the current policy that is associated with the stack is unchanged.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 16384.

Required: No

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 don't specify a stack policy, the current policy that is associated with the stack will be used.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 16384.

Required: No

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. The location for an Amazon S3 bucket must start with https://. 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 don't specify a stack policy, the current policy that is associated with the stack will be used.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1350.

Required: No

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. The location for an Amazon S3 bucket must start with https://. 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 don't specify a stack policy, the current policy that is associated with the stack is unchanged.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1350.

Required: No

Tags.member.N

Key-value pairs to associate with this stack. Amazon CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, Amazon CloudFormation doesn't modify the stack's tags. If you specify an empty value, Amazon CloudFormation removes all associated tags.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: No

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 Amazon CloudFormation User Guide.)

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

Type: String

Length Constraints: Minimum length of 1.

Required: No

TemplateURL

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the Amazon CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

UsePreviousTemplate

Reuse the existing template that is associated with the stack that you are updating.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

Type: Boolean

Required: No

Response Elements

The following element is returned by the service.

StackId

Unique identifier of the stack.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InsufficientCapabilities

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

HTTP Status Code: 400

TokenAlreadyExists

A client request token already exists.

HTTP Status Code: 400

Examples

UpdateStack

This example illustrates one usage of UpdateStack.

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=UpdateStack &StackName=MyStack &TemplateBody=[Template Document] &Parameters.member.1.ParameterKey=AvailabilityZone &Parameters.member.1.ParameterValue=us-east-1a &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]

Sample Response

<UpdateStackResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/"> <UpdateStackResult> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> </UpdateStackResult> <ResponseMetadata> <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId> </ResponseMetadata> </UpdateStackResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: