Class: Aws::CloudFormation::StackResourceSummary

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

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


24
25
26
27
28
29
30
31
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 24

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)
  @waiter_block_warned = false
end

Instance Method Details

#client ⇒ Client

Returns:



108
109
110
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 108

def client
  @client
end

#data ⇒ Types::StackResourceSummary

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

Returns:

Raises:

  • (NotImplementedError) —

    Raises when #data_loaded? is ‘false`.



123
124
125
126
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 123

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.



131
132
133
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 131

def data_loaded?
  !!@data
end

#drift_information ⇒ Types::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 [Detect unmanaged configuration changes to stacks and resources with drift detection].

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

Returns:



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

def drift_information
  data[:drift_information]
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. 


247
248
249
250
251
252
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 247

def identifiers
  {
    stack_name: @stack_name,
    logical_id: @logical_id
  }
end

#last_updated_timestamp ⇒ Time

Time the status was updated.

Returns:

  • (Time) 


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

def last_updated_timestamp
  data[:last_updated_timestamp]
end

#load ⇒ Object Also known as: reload

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.

Raises:

  • (NotImplementedError) 


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

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#logical_id ⇒ String Also known as: logical_resource_id

Returns:

  • (String) 


41
42
43
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 41

def logical_id
  @logical_id
end

#module_info ⇒ Types::ModuleInfo

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Returns:



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

def module_info
  data[:module_info]
end

#physical_resource_id ⇒ String

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 49

def physical_resource_id
  data[:physical_resource_id]
end

#resource ⇒ StackResource

Returns:



237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 237

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

#resource_status ⇒ String

Current status of the resource.

Returns:

  • (String) 


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

def resource_status
  data[:resource_status]
end

#resource_status_reason ⇒ String

Success/failure message associated with the resource.

Returns:

  • (String) 


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

def resource_status_reason
  data[:resource_status_reason]
end

#resource_type ⇒ String

Type of resource. (For more information, see [Amazon Web Services resource and property types reference] in the *CloudFormation User Guide*.)

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

Returns:

  • (String) 


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

def resource_type
  data[:resource_type]
end

#stack_name ⇒ String

Returns:

  • (String) 


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

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 215

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