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

Class: Aws::CloudFormation::Event

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Event #initialize(options = {}) ⇒ Event

Returns a new instance of Event

Overloads:

  • #initialize(id, options = {}) ⇒ Event

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Event

    Options Hash (options):

    • :id (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 19

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

Instance Method Details

#clientClient

Returns:



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

def client
  @client
end

#client_request_tokenString

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

Returns:

  • (String)


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

def client_request_token
  data[:client_request_token]
end

#dataTypes::StackEvent

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

Returns:

Raises:



132
133
134
135
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 132

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.



140
141
142
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 140

def data_loaded?
  !!@data
end

#idString Also known as: event_id

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 29

def id
  @id
end

#logical_resource_idString

The logical name of the resource specified in the template.

Returns:

  • (String)


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

def logical_resource_id
  data[:logical_resource_id]
end

#physical_resource_idString

The name or unique identifier associated with the physical instance of the resource.

Returns:

  • (String)


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

def physical_resource_id
  data[:physical_resource_id]
end

#resource_propertiesString

BLOB of the properties used to create the resource.

Returns:

  • (String)


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

def resource_properties
  data[:resource_properties]
end

#resource_statusString

Current status of the resource.

Returns:

  • (String)


78
79
80
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.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 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 84

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)


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

def resource_type
  data[:resource_type]
end

#stack_idString

The unique ID name of the instance of the stack.

Returns:

  • (String)


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

def stack_id
  data[:stack_id]
end

#stack_nameString

The name associated with a stack.

Returns:

  • (String)


42
43
44
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 42

def stack_name
  data[:stack_name]
end

#timestampTime

Time the status was updated.

Returns:

  • (Time)


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

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb', line 222

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