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

Class: Aws::CloudFormation::StackResourceSummary

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(stack_name, logical_id, options = {}) ⇒ StackResourceSummary #initialize(options = {}) ⇒ StackResourceSummary

Returns a new instance of StackResourceSummary

Overloads:

  • #initialize(stack_name, logical_id, options = {}) ⇒ StackResourceSummary

    Parameters:

    • stack_name (String)
    • logical_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ StackResourceSummary

    Options Hash (options):

    • :stack_name (required, String)
    • :logical_id (required, String)
    • :client (Client)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 21

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

Instance Method Details

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::StackResourceSummary

Returns the data for this Aws::CloudFormation::StackResourceSummary.

Returns:

Raises:



110
111
112
113
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 110

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.



118
119
120
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 118

def data_loaded?
  !!@data
end

#drift_informationTypes::StackResourceDriftInformationSummary

Information about whether the resource'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.



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

def drift_information
  data[:drift_information]
end

#last_updated_timestampTime

Time the status was updated.

Returns:

  • (Time)


62
63
64
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 62

def last_updated_timestamp
  data[:last_updated_timestamp]
end

#logical_idString Also known as: logical_resource_id

Returns:

  • (String)


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

def logical_id
  @logical_id
end

#physical_resource_idString

The name or unique identifier that corresponds to a physical instance ID of the resource.

Returns:

  • (String)


45
46
47
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 45

def physical_resource_id
  data[:physical_resource_id]
end

#resourceStackResource

Returns:



220
221
222
223
224
225
226
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 220

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

#resource_statusString

Current status of the resource.

Returns:

  • (String)


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

def resource_status
  data[:resource_status]
end

#resource_status_reasonString

Success/failure message associated with the resource.

Returns:

  • (String)


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

def resource_status_reason
  data[:resource_status_reason]
end

#resource_typeString

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Returns:

  • (String)


56
57
58
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 56

def resource_type
  data[:resource_type]
end

#stack_nameString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 32

def stack_name
  @stack_name
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 200

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