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

Class: Aws::CloudFormation::Event

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

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

    Parameters:

    • id (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

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

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#client_request_tokenString (readonly)

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)

    The token passed to the operation that generated this event.

#event_idString (readonly)

The unique ID of this event.

Returns:

  • (String)

    The unique ID of this event.

#idString (readonly)

Returns:

  • (String)

#logical_resource_idString (readonly)

The logical name of the resource specified in the template.

Returns:

  • (String)

    The logical name of the resource specified in the template.

#physical_resource_idString (readonly)

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

Returns:

  • (String)

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

#resource_propertiesString (readonly)

BLOB of the properties used to create the resource.

Returns:

  • (String)

    BLOB of the properties used to create the resource.

#resource_statusString (readonly)

Current status of the resource.

Possible values:

  • CREATE_IN_PROGRESS
  • CREATE_FAILED
  • CREATE_COMPLETE
  • DELETE_IN_PROGRESS
  • DELETE_FAILED
  • DELETE_COMPLETE
  • DELETE_SKIPPED
  • UPDATE_IN_PROGRESS
  • UPDATE_FAILED
  • UPDATE_COMPLETE

Returns:

  • (String)

    Current status of the resource.

#resource_status_reasonString (readonly)

Success/failure message associated with the resource.

Returns:

  • (String)

    Success/failure message associated with the resource.

#resource_typeString (readonly)

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Returns:

  • (String)

    Type of resource.

#stack_idString (readonly)

The unique ID name of the instance of the stack.

Returns:

  • (String)

    The unique ID name of the instance of the stack.

#stack_nameString (readonly)

The name associated with a stack.

Returns:

  • (String)

    The name associated with a stack.

#timestampTime (readonly)

Time the status was updated.

Returns:

  • (Time)

    Time the status was updated.