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

Class: Aws::CloudFormation::Stack

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Stack #initialize(options = {}) ⇒ Stack

Returns a new instance of Stack

Overloads:

  • #initialize(name, options = {}) ⇒ Stack

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Stack

    Options Hash (options):

    • :name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#cancel_update(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


stack.cancel_update({
  client_request_token: "ClientRequestToken",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :client_request_token (String)

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

Returns:

  • (EmptyStructure)


213
214
215
216
217
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 213

def cancel_update(options = {})
  options = options.merge(stack_name: @name)
  resp = @client.cancel_update_stack(options)
  resp.data
end

#capabilitiesArray<String>

The capabilities allowed in the stack.

Returns:

  • (Array<String>)


107
108
109
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 107

def capabilities
  data.capabilities
end

#change_set_idString

The unique ID of the change set.

Returns:

  • (String)


42
43
44
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 42

def change_set_id
  data.change_set_id
end

#clientClient

Returns:



135
136
137
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 135

def client
  @client
end

#create(options = {}) ⇒ Types::CreateStackOutput

Examples:

Request syntax with placeholder values


stack.create({
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
    },
  ],
  disable_rollback: false,
  timeout_in_minutes: 1,
  notification_arns: ["NotificationARN"],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  on_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :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 TemplateBody or the TemplateURL parameter, but not both.

  • :template_url (String)

    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

    Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

  • :parameters (Array<Types::Parameter>)

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

  • :disable_rollback (Boolean)

    Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

    Default: false

  • :timeout_in_minutes (Integer)

    The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

  • :notification_arns (Array<String>)

    The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

  • :capabilities (Array<String>)

    A list of values that you must specify before AWS CloudFormation can create 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.

  • :resource_types (Array<String>)

    The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).

    If the list of resource types doesn't include a resource that you're creating, the stack creation 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.

  • :role_arn (String)

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create 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.

  • :on_failure (String)

    Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

    Default: ROLLBACK

  • :stack_policy_body (String)

    Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

  • :stack_policy_url (String)

    Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) 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.

  • :tags (Array<Types::Tag>)

    Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

  • :client_request_token (String)

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



407
408
409
410
411
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 407

def create(options = {})
  options = options.merge(stack_name: @name)
  resp = @client.create_stack(options)
  resp.data
end

#creation_timeTime

The time at which the stack was created.

Returns:

  • (Time)


60
61
62
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 60

def creation_time
  data.creation_time
end

#dataTypes::Stack

Returns the data for this Aws::CloudFormation::Stack. Calls Client#describe_stacks if #data_loaded? is false.

Returns:



155
156
157
158
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 155

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



163
164
165
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 163

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


stack.delete({
  retain_resources: ["LogicalResourceId"],
  role_arn: "RoleARN",
  client_request_token: "ClientRequestToken",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :retain_resources (Array<String>)

    For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.

    Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

  • :role_arn (String)

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.

    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.

  • :client_request_token (String)

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

  • (EmptyStructure)


460
461
462
463
464
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 460

def delete(options = {})
  options = options.merge(stack_name: @name)
  resp = @client.delete_stack(options)
  resp.data
end

#descriptionString

A user-defined description associated with the stack.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 48

def description
  data.description
end

#disable_rollbackBoolean

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

Returns:

  • (Boolean)


89
90
91
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 89

def disable_rollback
  data.disable_rollback
end

#events(options = {}) ⇒ Event::Collection

Examples:

Request syntax with placeholder values


stack.events()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 682

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(stack_name: @name)
    resp = @client.describe_stack_events(options)
    resp.each_page do |page|
      batch = []
      page.data.stack_events.each do |s|
        batch << Event.new(
          id: s.event_id,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Event::Collection.new(batches)
end

#exists?(options = {}) ⇒ Boolean

Returns true if the Stack exists.

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (Boolean)

    Returns true if the Stack exists.



170
171
172
173
174
175
176
177
178
179
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 170

def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end

#last_updated_timeTime

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Returns:

  • (Time)


67
68
69
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 67

def last_updated_time
  data.last_updated_time
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::CloudFormation::Stack. Returns self making it possible to chain methods.

stack.reload.data

Returns:

  • (self)


145
146
147
148
149
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 145

def load
  resp = @client.describe_stacks(stack_name: @name)
  @data = resp.stacks[0]
  self
end

#nameString Also known as: stack_name

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 29

def name
  @name
end

#notification_arnsArray<String>

SNS topic ARNs to which stack related events are published.

Returns:

  • (Array<String>)


95
96
97
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 95

def notification_arns
  data.notification_arns
end

#outputsArray<Types::Output>

A list of output structures.

Returns:



113
114
115
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 113

def outputs
  data.outputs
end

#parametersArray<Types::Parameter>

A list of Parameter structures.

Returns:



54
55
56
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 54

def parameters
  data.parameters
end

#resource(logical_id) ⇒ StackResource

Parameters:

  • logical_id (String)

Returns:



703
704
705
706
707
708
709
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 703

def resource(logical_id)
  StackResource.new(
    stack_name: @name,
    logical_id: logical_id,
    client: @client
  )
end

#resource_summaries(options = {}) ⇒ StackResourceSummary::Collection

Examples:

Request syntax with placeholder values


stack.resource_summaries()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 716

def resource_summaries(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(stack_name: @name)
    resp = @client.list_stack_resources(options)
    resp.each_page do |page|
      batch = []
      page.data.stack_resource_summaries.each do |s|
        batch << StackResourceSummary.new(
          logical_id: s.logical_resource_id,
          stack_name: options[:stack_name],
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  StackResourceSummary::Collection.new(batches)
end

#role_arnString

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

Returns:

  • (String)


122
123
124
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 122

def role_arn
  data.role_arn
end

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 36

def stack_id
  data.stack_id
end

#stack_statusString

Current status of the stack.

Returns:

  • (String)


73
74
75
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 73

def stack_status
  data.stack_status
end

#stack_status_reasonString

Success/failure message associated with the stack status.

Returns:

  • (String)


79
80
81
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 79

def stack_status_reason
  data.stack_status_reason
end

#tagsArray<Types::Tag>

A list of Tags that specify information about the stack.

Returns:



128
129
130
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 128

def tags
  data.tags
end

#timeout_in_minutesInteger

The amount of time within which stack creation should complete.

Returns:

  • (Integer)


101
102
103
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 101

def timeout_in_minutes
  data.timeout_in_minutes
end

#update(options = {}) ⇒ Types::UpdateStackOutput

Examples:

Request syntax with placeholder values


stack.update({
  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",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :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 only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

  • :template_url (String)

    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.

  • :use_previous_template (Boolean)

    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.

  • :stack_policy_during_update_body (String)

    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.

  • :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 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.

  • :parameters (Array<Types::Parameter>)

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

  • :capabilities (Array<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.

  • :resource_types (Array<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.

  • :role_arn (String)

    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.

  • :stack_policy_body (String)

    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.

  • :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 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.

  • :notification_arns (Array<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.

  • :tags (Array<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.

  • :client_request_token (String)

    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:



669
670
671
672
673
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 669

def update(options = {})
  options = options.merge(stack_name: @name)
  resp = @client.update_stack(options)
  resp.data
end

#wait_until_exists(options = {}) ⇒ Stack

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 20
  • :delay (Float) — default: 5
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



187
188
189
190
191
192
193
194
195
196
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 187

def wait_until_exists(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::StackExists.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  waiter.wait(params.merge(stack_name: @name))
  Stack.new({
    name: @name,
    client: @client
  })
end