Class: Aws::CloudFormation::StackResource

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of StackResource.

Overloads:

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

    Parameters:

    • stack_name (String)
    • logical_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ StackResource

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

#clientClient

Returns:


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

def client
  @client
end

#dataTypes::StackResourceDetail

Returns the data for this Aws::CloudFormation::StackResource. Calls Client#describe_stack_resource if #data_loaded? is `false`.


154
155
156
157
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 154

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.


162
163
164
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 162

def data_loaded?
  !!@data
end

#descriptionString

User defined description associated with the resource.

Returns:

  • (String)

90
91
92
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 90

def description
  data[:description]
end

#drift_informationTypes::StackResourceDriftInformation

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

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


116
117
118
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 116

def drift_information
  data[:drift_information]
end

#identifiersObject

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.

275
276
277
278
279
280
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 275

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

#last_updated_timestampTime

Time the status was updated.

Returns:

  • (Time)

72
73
74
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 72

def last_updated_timestamp
  data[:last_updated_timestamp]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::CloudFormation::StackResource. Returns `self` making it possible to chain methods.

stack_resource.reload.data

Returns:

  • (self)

141
142
143
144
145
146
147
148
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 141

def load
  resp = @client.describe_stack_resource(
    logical_resource_id: @logical_id,
    stack_name: @stack_name
  )
  @data = resp.stack_resource_detail
  self
end

#logical_idString Also known as: logical_resource_id

Returns:

  • (String)

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

def logical_id
  @logical_id
end

#metadataString

The content of the `Metadata` attribute declared for the resource. For more information, see [Metadata Attribute] in the CloudFormation User Guide.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

Returns:

  • (String)

102
103
104
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 102

def 
  data[:metadata]
end

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


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

def module_info
  data[:module_info]
end

#physical_resource_idString

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

Returns:

  • (String)

55
56
57
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 55

def physical_resource_id
  data[:physical_resource_id]
end

#resource_statusString

Current status of the resource.

Returns:

  • (String)

78
79
80
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 78

def resource_status
  data[:resource_status]
end

#resource_status_reasonString

Success/failure message associated with the resource.

Returns:

  • (String)

84
85
86
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 84

def resource_status_reason
  data[:resource_status_reason]
end

#resource_typeString

Type of resource. ((For more information, go to [Amazon Web Services Resource Types Reference] in the CloudFormation User Guide.)

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

Returns:

  • (String)

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

def resource_type
  data[:resource_type]
end

#stackStack

Returns:


266
267
268
269
270
271
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 266

def stack
  Stack.new(
    name: @stack_name,
    client: @client
  )
end

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)

48
49
50
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 48

def stack_id
  data[:stack_id]
end

#stack_nameString

Returns:

  • (String)

36
37
38
# File 'lib/aws-sdk-cloudformation/stack_resource.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


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 246

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