You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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,
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
  notification_arns: ["NotificationARN"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
}

The input for an UpdateStack action.

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

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

Returns:

  • (Array<String>)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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 AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS 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)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  include Aws::Structure
end

#notification_arnsArray<String>

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

Returns:

  • (Array<String>)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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.

Returns:



4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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

Returns:

  • (Array<String>)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  include Aws::Structure
end

#stack_nameString

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

Returns:

  • (String)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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 AWS CloudFormation User Guide.)

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

Returns:

  • (String)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

Returns:

  • (String)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  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)


4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4296

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,
  :stack_policy_body,
  :stack_policy_url,
  :notification_arns,
  :tags,
  :client_request_token)
  include Aws::Structure
end