class Aws::CloudFormation::Event

Public Class Methods

new(*args) click to toggle source

@overload def initialize(id, options = {})

@param [String] id
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :id
@option options [Client] :client
# File lib/aws-sdk-cloudformation/event.rb, line 22
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)
  @waiter_block_warned = false
end

Public Instance Methods

client() click to toggle source

@return [Client]

# File lib/aws-sdk-cloudformation/event.rb, line 157
def client
  @client
end
client_request_token() click to toggle source

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`. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 114
def client_request_token
  data[:client_request_token]
end
data() click to toggle source

@raise [NotImplementedError] Raises when {#data_loaded?} is ‘false`. @return [Types::StackEvent]

Returns the data for this {Event}.
# File lib/aws-sdk-cloudformation/event.rb, line 172
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-cloudformation/event.rb, line 180
def data_loaded?
  !!@data
end
event_id()
Alias for: id
hook_failure_mode() click to toggle source

Specify the hook failure mode for non-compliant resources in the followings ways.

  • ‘FAIL` Stops provisioning resources.

  • ‘WARN` Allows provisioning to continue with a warning message.

@return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 150
def hook_failure_mode
  data[:hook_failure_mode]
end
hook_invocation_point() click to toggle source

Invocation points are points in provisioning logic where hooks are initiated. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 139
def hook_invocation_point
  data[:hook_invocation_point]
end
hook_status() click to toggle source

Provides the status of the change set hook. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 126
def hook_status
  data[:hook_status]
end
hook_status_reason() click to toggle source

Provides the reason for the hook status. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 132
def hook_status_reason
  data[:hook_status_reason]
end
hook_type() click to toggle source

The name of the hook. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 120
def hook_type
  data[:hook_type]
end
id() click to toggle source

@return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 33
def id
  @id
end
Also aliased as: event_id
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-cloudformation/event.rb, line 283
def identifiers
  { id: @id }
end
load() click to toggle source

@raise [NotImplementedError] @api private

# File lib/aws-sdk-cloudformation/event.rb, line 163
def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end
Also aliased as: reload
logical_resource_id() click to toggle source

The logical name of the resource specified in the template. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 52
def logical_resource_id
  data[:logical_resource_id]
end
physical_resource_id() click to toggle source

The name or unique identifier associated with the physical instance of the resource. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 59
def physical_resource_id
  data[:physical_resource_id]
end
reload()
Alias for: load
resource_properties() click to toggle source

BLOB of the properties used to create the resource. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 94
def resource_properties
  data[:resource_properties]
end
resource_status() click to toggle source

Current status of the resource. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 82
def resource_status
  data[:resource_status]
end
resource_status_reason() click to toggle source

Success/failure message associated with the resource. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 88
def resource_status_reason
  data[:resource_status_reason]
end
resource_type() click to toggle source

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 @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 70
def resource_type
  data[:resource_type]
end
stack_id() click to toggle source

The unique ID name of the instance of the stack. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 40
def stack_id
  data[:stack_id]
end
stack_name() click to toggle source

The name associated with a stack. @return [String]

# File lib/aws-sdk-cloudformation/event.rb, line 46
def stack_name
  data[:stack_name]
end
timestamp() click to toggle source

Time the status was updated. @return [Time]

# File lib/aws-sdk-cloudformation/event.rb, line 76
def timestamp
  data[:timestamp]
end
wait_until(options = {}, &block) click to toggle source

@deprecated Use [Aws::CloudFormation::Client] wait_until instead

Waiter polls an API operation until a resource enters a desired state.

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

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

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [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.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-cloudformation/event.rb, line 264
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

Private Instance Methods

extract_id(args, options) click to toggle source
# File lib/aws-sdk-cloudformation/event.rb, line 290
def extract_id(args, options)
  value = args[0] || options.delete(:id)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :id"
  else
    msg = "expected :id to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end