Class AWS::CloudFormation::Stack
In: lib/aws/cloud_formation/stack.rb
Parent: Core::Resource

@attr_reader [String] template Returns the stack‘s template as a JSON

  string.

@attr_reader [Time] creation_time The time the stack was created.

@attr_reader [Time,nil] last_updated_time The time the stack was

  last updated.

@attr_reader [String] stack_id Unique stack identifier.

@attr_reader [String] status The status of the stack.

@attr_reader [String] status_reason Success/Failure message

  associated with the `status`.

@attr_reader [Array<String>] capabilities The capabilities

  allowed in the stack.

@attr_reader [String] description User defined description

  associated with the stack.

@attr_reader [Boolean] disable_rollback Specifies if the stack

  is rolled back due to stack creation errors.

@attr_reader [Array<String>] notification_arns

  SNS topic ARNs to which stack related events are published.

@attr_reader [Hash] parameters Returns a hash of stack parameters.

@attr_reader [Integer] timeout

  The number of minutes within the stack creation should complete.

Methods

Included Modules

StackOptions

External Aliases

template -> template_body
disable_rollback -> disable_rollback?
timeout -> timeout_in_minutes

Attributes

name  [R]  @return [String] Returns the stack name.

Public Class methods

Public Instance methods

Deletes the current stack. @return [nil]

@return [StackEventCollection] Returns a collection that represents

  all events for this stack.

@return [Boolean]

@return [Array<StackOutput>]

Returns a stack resource summary collection, that when enumerated yields summary hashes. Each hash has the following keys:

  • `:last_updated_timestamp`
  • `:logical_resource_id`
  • `:physical_resource_id`
  • `:resource_status`
  • `:resource_status_reason`
  • `:resource_type`

@return [StackResourceSummaryCollection]

Returns a stack resource collection that enumerates all resources for this stack.

    stack.resources.each do |resource|
      puts "#{resource.resource_type}: #{resource.physical_resource_id}"
    end

If you want a specific resource and you know its logical resource id, you can use this collection to return a reference to it.

    resource = stack.resources['logical-resource-id']

@return [StackResourceCollection]

@param [Hash] options

@option options [String,URI,S3::S3Object,Object] :template

  A new stack template.  This may be provided in a number of formats
  including:

    * a String, containing the template as a JSON document.
    * a URL String pointing to the document in S3.
    * a URI object pointing to the document in S3.
    * an {S3::S3Object} which contains the template.
    * an Object which responds to #to_json and returns the template.

@option options [Hash] :parameters A hash that specifies the

  input parameters of the new stack.

@option options[Array<String>] :capabilities The list of capabilities

  that you want to allow in the stack. If your stack contains IAM
  resources, you must specify the CAPABILITY_IAM value for this
  parameter; otherwise, this action returns an
  InsufficientCapabilities error. IAM resources are the following:

    * AWS::IAM::AccessKey
    * AWS::IAM::Group
    * AWS::IAM::Policy
    * AWS::IAM::User
    * AWS::IAM::UserToGroupAddition

@return [nil]

Protected Instance methods

[Validate]