Class: Aws::CloudFormation::Types::UpdateStackInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass UpdateStackInput data as a hash:

{
  stack_name: "StackName", # required
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  use_previous_template: false,
  stack_policy_during_update_body: "StackPolicyDuringUpdateBody",
  stack_policy_during_update_url: "StackPolicyDuringUpdateURL",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  rollback_configuration: {
    rollback_triggers: [
      {
        arn: "Arn", # required
        type: "Type", # required
      },
    ],
    monitoring_time_in_minutes: 1,
  },
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
  notification_arns: ["NotificationARN"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  disable_rollback: false,
  client_request_token: "ClientRequestToken",
}

The input for an UpdateStack action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for 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 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, CloudFormation returns an `InsufficientCapabilities` error.

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

    • AWS::IAM::AccessKey][1
    • AWS::IAM::Group][2
    • AWS::IAM::InstanceProfile][3
    • AWS::IAM::Policy][4
    • AWS::IAM::Role][5
    • AWS::IAM::User][6
    • AWS::IAM::UserToGroupAddition][7

    For more information, see [Acknowledging IAM Resources in 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 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.

    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 CloudFormation being notified.

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html [3]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html [4]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html [5]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html [6]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html [7]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html [8]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities [9]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html [10]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html [11]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html

Returns:

  • (Array<String>)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

A unique identifier for this `UpdateStack` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry `UpdateStack` requests to ensure that 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`.

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#disable_rollbackBoolean

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

Default: `False`

Returns:

  • (Boolean)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arnsArray<String>

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

Returns:

  • (Array<String>)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#parametersArray<Types::Parameter>

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html

Returns:


9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typesArray<String>

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see [Controlling Access with Identity and Access Management].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html

Returns:

  • (Array<String>)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_configurationTypes::RollbackConfiguration

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


9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

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

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_policy_bodyString

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.

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_policy_during_update_bodyString

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.

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_policy_during_update_urlString

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.

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_policy_urlString

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.

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Returns:


9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#template_bodyString

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

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#template_urlString

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to [Template Anatomy] in the CloudFormation User Guide.

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

Returns:

  • (String)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#use_previous_templateBoolean

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`.

Returns:

  • (Boolean)

9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
# File 'lib/aws-sdk-cloudformation/types.rb', line 9559

class UpdateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :stack_policy_during_update_body,
  :stack_policy_during_update_url,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :disable_rollback,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end