AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Table Of Contents

Feedback

[ aws . cloudformation ]

update-stack

Description

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 describe-stacks action.

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

Tags that were associated with this stack during creation time will still be associated with the stack after an update-stack operation.

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

Synopsis

  update-stack
--stack-name <value>
[--template-body <value>]
[--template-url <value>]
[--use-previous-template | --no-use-previous-template]
[--stack-policy-during-update-body <value>]
[--stack-policy-during-update-url <value>]
[--parameters <value>]
[--capabilities <value>]
[--stack-policy-body <value>]
[--stack-policy-url <value>]
[--notification-arns <value>]

Options

--stack-name (string)

The name or stack ID of the stack to update.

--template-body (string)

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 template-body or the template-url parameter, but not both.

--template-url (string)

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 template-body or the template-url parameter, but not both.

--use-previous-template | --no-use-previous-template (boolean)

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

--stack-policy-during-update-body (string)

Structure containing the temporary overriding stack policy body. You can specify either the stack-policy-during-update-body or the stack-policy-during-update-url 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.

--stack-policy-during-update-url (string)

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 stack-policy-during-update-body or the stack-policy-during-update-url 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 (list)

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

Shorthand Syntax:

  Key value pairs, with multiple values separated by a space.
--parameters ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean

JSON Syntax:

[
  {
    "ParameterKey": "string",
    "ParameterValue": "string",
    "UsePreviousValue": true|false
  }
  ...
]

--capabilities (list)

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 .

Syntax:

"string" "string" ...

Where valid values are:
  CAPABILITY_IAM

--stack-policy-body (string)

Structure containing a new stack policy body. You can specify either the stack-policy-body or the stack-policy-url 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.

--stack-policy-url (string)

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 stack-policy-body or the stack-policy-url 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.

--notification-arns (list)

Update the ARNs for the Amazon SNS topics that are associated with the stack.

Syntax:

"string" "string" ...

Output

StackId -> (string)

Unique identifier of the stack.