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)


382
383
384
385
386
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 382

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>)


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

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:



209
210
211
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 209

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,
      resolved_value: "ParameterValue",
    },
  ],
  disable_rollback: false,
  rollback_configuration: {
    rollback_triggers: [
      {
        arn: "Arn", # required
        type: "Type", # required
      },
    ],
    monitoring_time_in_minutes: 1,
  },
  timeout_in_minutes: 1,
  notification_arns: ["NotificationARN"],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  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",
  enable_termination_protection: false,
})

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

  • :rollback_configuration (Types::RollbackConfiguration)

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

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

    In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      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 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, AWS 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.

      For more information, see Acknowledging IAM Resources in AWS 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 creating the stack. If your stack template contains one or more macros, and you choose to create 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 AWS CloudFormation.

      Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

      You should only create 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 AWS CloudFormation being notified.

      For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on 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.

  • :enable_termination_protection (Boolean)

    Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.

    For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

Returns:



660
661
662
663
664
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 660

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:



229
230
231
232
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 229

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.



237
238
239
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 237

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)


713
714
715
716
717
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 713

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

#deletion_timeTime

The time the stack was deleted.

Returns:

  • (Time)


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

def deletion_time
  data[:deletion_time]
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)


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

def disable_rollback
  data[:disable_rollback]
end

#drift_informationTypes::StackDriftInformation

Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.



202
203
204
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 202

def drift_information
  data[:drift_information]
end

#enable_termination_protectionBoolean

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.

Returns:

  • (Boolean)


158
159
160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 158

def enable_termination_protection
  data[:enable_termination_protection]
end

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

Examples:

Request syntax with placeholder values


stack.events()

Parameters:

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

    ({})

Returns:



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 1003

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.



244
245
246
247
248
249
250
251
252
253
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 244

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)


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

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)


219
220
221
222
223
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 219

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>)


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

def notification_arns
  data[:notification_arns]
end

#outputsArray<Types::Output>

A list of output structures.

Returns:



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

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

#parent_idString

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

Returns:

  • (String)


173
174
175
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 173

def parent_id
  data[:parent_id]
end

#resource(logical_id) ⇒ StackResource

Parameters:

  • logical_id (String)

Returns:



1024
1025
1026
1027
1028
1029
1030
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 1024

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:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 1037

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)


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

def role_arn
  data[:role_arn]
end

#rollback_configurationTypes::RollbackConfiguration

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



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

def rollback_configuration
  data[:rollback_configuration]
end

#root_idString

For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

Returns:

  • (String)


188
189
190
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 188

def root_id
  data[:root_id]
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)


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

def stack_status
  data[:stack_status]
end

#stack_status_reasonString

Success/failure message associated with the stack status.

Returns:

  • (String)


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

def stack_status_reason
  data[:stack_status_reason]
end

#tagsArray<Types::Tag>

A list of Tags that specify information about the stack.

Returns:



142
143
144
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 142

def tags
  data[:tags]
end

#timeout_in_minutesInteger

The amount of time within which stack creation should complete.

Returns:

  • (Integer)


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

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,
      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
    },
  ],
  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>)

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

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      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 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, AWS 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.

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

      Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.

      For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on 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.

  • :rollback_configuration (Types::RollbackConfiguration)

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

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



990
991
992
993
994
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 990

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

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::CloudFormation::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 350

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

#wait_until_exists(options = {}, &block) ⇒ 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:



261
262
263
264
265
266
267
268
269
270
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb', line 261

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