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

Class: Aws::CloudFormation::StackResource

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes 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)


21
22
23
24
25
26
27
28
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.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)
  @waiter_block_warned = false
end

Instance Method Details

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::StackResourceDetail



143
144
145
146
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 143

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.



151
152
153
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 151

def data_loaded?
  !!@data
end

#descriptionString

User defined description associated with the resource.

Returns:

  • (String)


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

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.



113
114
115
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 113

def drift_information
  data[:drift_information]
end

#last_updated_timestampTime

Time the status was updated.

Returns:

  • (Time)


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

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)


130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 130

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)


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

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

Returns:

  • (String)


99
100
101
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 99

def 
  data[:metadata]
end

#physical_resource_idString

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

Returns:

  • (String)


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

def physical_resource_id
  data[:physical_resource_id]
end

#resource_statusString

Current status of the resource.

Returns:

  • (String)


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

def resource_status
  data[:resource_status]
end

#resource_status_reasonString

Success/failure message associated with the resource.

Returns:

  • (String)


81
82
83
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 81

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)


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

def resource_type
  data[:resource_type]
end

#stackStack

Returns:



253
254
255
256
257
258
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 253

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

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)


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

def stack_id
  data[:stack_id]
end

#stack_nameString

Returns:

  • (String)


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

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb', line 233

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