Class: Aws::CloudFormation::Stack

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

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


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 22

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)
  @waiter_block_warned = false
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 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 CloudFormation successfully received them.

Returns:

  • (EmptyStructure) 


433
434
435
436
437
438
439
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 433

def cancel_update(options = {})
  options = options.merge(stack_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.cancel_update_stack(options)
  end
  resp.data
end

#capabilities ⇒ Array<String>

The capabilities allowed in the stack.

Returns:

  • (Array<String>) 


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

def capabilities
  data[:capabilities]
end

#change_set_id ⇒ String

The unique ID of the change set.

Returns:

  • (String) 


46
47
48
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 46

def change_set_id
  data[:change_set_id]
end

#client ⇒ Client

Returns:



252
253
254
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 252

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,
  retain_except_on_create: 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][1

    in the *CloudFormation User Guide*.

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

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

  • :template_url (String) —

    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that’s located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the

    Template anatomy][1

    in the *CloudFormation User Guide*. The location

    for an Amazon S3 bucket must start with ‘https://`.

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

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

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

  • :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 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 Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

  • :capabilities (Array<String>) —

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create 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 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][10

      transforms, which are macros hosted by

      CloudFormation.

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

      For more information, see [Using CloudFormation macros to perform custom processing on templates].

    <note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

    </note>

    [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

  • :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 Amazon Web Services resources), `Custom::*` (for all custom resources), `Custom::logical_ID ` (for a specific custom resource), `AWS::service_name::*` (for all resources of a particular Amazon Web Services service), and `AWS::service_name::resource_logical_ID ` (for a specific Amazon Web Services resource).

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

    <note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

    </note>

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

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create 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. Provided that 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’s 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 *CloudFormation User Guide*. You can specify either the ‘StackPolicyBody` or the `StackPolicyURL` parameter, but not both.

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html

  • :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. The location for an Amazon S3 bucket must start with ‘https://`. 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. 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 CloudFormation knows that you’re not attempting to create a stack with the same name. You might retry ‘CreateStack` requests to ensure that CloudFormation successfully received them.

    All events initiated 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 *CloudFormation User Guide*. Termination protection is deactivated on stacks by default.

    For [nested stacks], termination protection is set on the root stack and can’t be changed directly on the nested stack.

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

  • :retain_except_on_create (Boolean) —

    When set to ‘true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.

    Default: ‘false`

Returns:



731
732
733
734
735
736
737
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 731

def create(options = {})
  options = options.merge(stack_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_stack(options)
  end
  resp.data
end

#creation_time ⇒ Time

The time at which the stack was created.

Returns:

  • (Time) 


64
65
66
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 64

def creation_time
  data[:creation_time]
end

#data ⇒ Types::Stack

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

Returns:



274
275
276
277
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 274

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.



282
283
284
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 282

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",
  deletion_mode: "STANDARD", # accepts STANDARD, FORCE_DELETE_STACK
})

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, CloudFormation deletes the stack but doesn’t delete the retained resources.

    Retaining resources is useful when you can’t 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 Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role’s credentials to make calls on your behalf.

    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’s 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 CloudFormation knows that you’re not attempting to delete a stack with the same name. You might retry ‘DeleteStack` requests to ensure that CloudFormation successfully received them.

    All events initiated 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`.

  • :deletion_mode (String) —

    Specifies the deletion mode for the stack. Possible values are:

    • ‘STANDARD` - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

    • ‘FORCE_DELETE_STACK` - Delete the stack if it’s stuck in a ‘DELETE_FAILED` state due to resource deletion failure.

Returns:

  • (EmptyStructure) 


795
796
797
798
799
800
801
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 795

def delete(options = {})
  options = options.merge(stack_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_stack(options)
  end
  resp.data
end

#deletion_mode ⇒ String

Specifies the deletion mode for the stack. Possible values are:

  • ‘STANDARD` - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

  • ‘FORCE_DELETE_STACK` - Delete the stack if it’s stuck in a ‘DELETE_FAILED` state due to resource deletion failure.

Returns:

  • (String) 


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

def deletion_mode
  data[:deletion_mode]
end

#deletion_time ⇒ Time

The time the stack was deleted.

Returns:

  • (Time) 


70
71
72
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 70

def deletion_time
  data[:deletion_time]
end

#description ⇒ String

A user-defined description associated with the stack.

Returns:

  • (String) 


52
53
54
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 52

def description
  data[:description]
end

#detailed_status ⇒ String

The detailed status of the resource or stack. If ‘CONFIGURATION_COMPLETE` is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets `CONFIGURATION_COMPLETE` when all of the resources in the stack have reached that event. For more information, see [CloudFormation stack deployment] in the *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html

Returns:

  • (String) 


245
246
247
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 245

def detailed_status
  data[:detailed_status]
end

#disable_rollback ⇒ Boolean

Boolean to enable or disable rollback on stack creation failures:

  • ‘true`: disable rollback.

  • ‘false`: enable rollback.

Returns:

  • (Boolean) 


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

def disable_rollback
  data[:disable_rollback]
end

#drift_information ⇒ Types::StackDriftInformation

Information about whether a stack’s actual configuration differs, or has drifted, from its 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].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html

Returns:



207
208
209
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 207

def drift_information
  data[:drift_information]
end

#enable_termination_protection ⇒ Boolean

Whether termination protection is enabled for the stack.

For [nested stacks], termination protection is set on the root stack and can’t be changed directly on the nested stack. For more information, see [Protecting a Stack From Being Deleted] in the *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html

Returns:

  • (Boolean) 


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

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:



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 1114

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(stack_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_stack_events(options)
    end
    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.



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 289

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

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1174
1175
1176
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 1174

def identifiers
  { name: @name }
end

#last_updated_time ⇒ Time

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

Returns:

  • (Time) 


77
78
79
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 77

def last_updated_time
  data[:last_updated_time]
end

#load ⇒ self 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) 


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

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_stacks(stack_name: @name)
  end
  @data = resp.stacks[0]
  self
end

#name ⇒ String Also known as: stack_name

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 33

def name
  @name
end

#notification_arns ⇒ Array<String>

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

Returns:

  • (Array<String>) 


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

def notification_arns
  data[:notification_arns]
end

#outputs ⇒ Array<Types::Output>

A list of output structures.

Returns:



132
133
134
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 132

def outputs
  data[:outputs]
end

#parameters ⇒ Array<Types::Parameter>

A list of ‘Parameter` structures.

Returns:



58
59
60
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 58

def parameters
  data[:parameters]
end

#parent_id ⇒ String

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

Returns:

  • (String) 


178
179
180
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 178

def parent_id
  data[:parent_id]
end

#resource(logical_id) ⇒ StackResource

Parameters:

  • logical_id (String)

Returns:



1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 1137

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:



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 1150

def resource_summaries(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(stack_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_stack_resources(options)
    end
    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

#retain_except_on_create ⇒ Boolean

When set to ‘true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.

Default: ‘false`

Returns:

  • (Boolean) 


217
218
219
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 217

def retain_except_on_create
  data[:retain_except_on_create]
end

#role_arn ⇒ String

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

Returns:

  • (String) 


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

def role_arn
  data[:role_arn]
end

#rollback_configuration ⇒ Types::RollbackConfiguration

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

Returns:



85
86
87
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 85

def rollback_configuration
  data[:rollback_configuration]
end

#root_id ⇒ String

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

For more information, see [Working with Nested Stacks] in the *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

Returns:

  • (String) 


193
194
195
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 193

def root_id
  data[:root_id]
end

#stack_id ⇒ String

Unique identifier of the stack.

Returns:

  • (String) 


40
41
42
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 40

def stack_id
  data[:stack_id]
end

#stack_status ⇒ String

Current status of the stack.

Returns:

  • (String) 


91
92
93
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 91

def stack_status
  data[:stack_status]
end

#stack_status_reason ⇒ String

Success/failure message associated with the stack status.

Returns:

  • (String) 


97
98
99
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 97

def stack_status_reason
  data[:stack_status_reason]
end

#tags ⇒ Array<Types::Tag>

A list of ‘Tag`s that specify information about the stack.

Returns:



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

def tags
  data[:tags]
end

#timeout_in_minutes ⇒ Integer

The amount of time within which stack creation should complete.

Returns:

  • (Integer) 


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

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
    },
  ],
  disable_rollback: false,
  client_request_token: "ClientRequestToken",
  retain_except_on_create: 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][1

    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

  • :template_url (String) —

    Location of file containing the template body. The URL must point to a template that’s located in an Amazon S3 bucket or a Systems Manager document. For more information, go to [Template Anatomy] in the *CloudFormation User Guide*. The location for an Amazon S3 bucket must start with ‘https://`.

    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

  • :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 don’t 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. The location for an Amazon S3 bucket must start with ‘https://`. 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 don’t 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.

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

  • :capabilities (Array<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 suggest 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][10

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

    <note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

    </note>

    [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

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

    <note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

    </note>

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

  • :role_arn (String) —

    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. Provided that 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.

  • :rollback_configuration (Types::RollbackConfiguration) —

    The rollback triggers for 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 don’t 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. The location for an Amazon S3 bucket must start with ‘https://`. 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 don’t 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 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. 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.

  • :disable_rollback (Boolean) —

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

    Default: ‘False`

  • :client_request_token (String) —

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

  • :retain_except_on_create (Boolean) —

    When set to ‘true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.

    Default: ‘false`

Returns:



1099
1100
1101
1102
1103
1104
1105
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 1099

def update(options = {})
  options = options.merge(stack_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_stack(options)
  end
  resp.data
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) do |instance|
  instance.state.name == 'running'
end

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 399

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
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:



306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/aws-sdk-cloudformation/stack.rb', line 306

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?
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    waiter.wait(params.merge(stack_name: @name))
  end
  Stack.new({
    name: @name,
    client: @client
  })
end