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

Class: AWS::CloudFormation::StackEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/aws/cloud_formation/stack_event.rb

Overview

Stack Event

You can get stack events from a Stack object.

stack = cfm.stacks['stack-name']
stack.events.each do |event|
  puts "#{event.timestamp}: #{event.resource_status}"
end

Instance Attribute Summary collapse

Instance Attribute Details

#event_id ⇒ String (readonly)

Returns event_id The unique ID of this event.

Returns:

  • (String) —

    event_id The unique ID of this event.



39
40
41
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 39

def event_id
  @event_id
end

#logical_resource_id ⇒ String (readonly)

Returns The logical name of the resource specified in the template.

Returns:

  • (String) —

    The logical name of the resource specified in the template.



43
44
45
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 43

def logical_resource_id
  @logical_resource_id
end

#physical_resource_id ⇒ String (readonly)

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



47
48
49
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 47

def physical_resource_id
  @physical_resource_id
end

#resource_properties ⇒ String (readonly)

Returns BLOB of the properties used to create the resource.

Returns:

  • (String) —

    BLOB of the properties used to create the resource.



50
51
52
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 50

def resource_properties
  @resource_properties
end

#resource_status ⇒ Symbol (readonly)

Returns Current status of the resource.

Returns:

  • (Symbol) —

    Current status of the resource.



53
54
55
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 53

def resource_status
  @resource_status
end

#resource_status_reason ⇒ String? (readonly)

Returns Success/failure message associated with the resource.

Returns:

  • (String, nil) —

    Success/failure message associated with the resource.



57
58
59
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 57

def resource_status_reason
  @resource_status_reason
end

#resource_type ⇒ String (readonly)

Returns Type of the resource (e.g. 'AWS::EC2::Instance').

Returns:

  • (String) —

    Type of the resource (e.g. 'AWS::EC2::Instance').



60
61
62
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 60

def resource_type
  @resource_type
end

#stack ⇒ Stack (readonly)

Returns stack The stack this event belongs to.

Returns:

  • (Stack) —

    stack The stack this event belongs to.



36
37
38
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 36

def stack
  @stack
end

#stack_id ⇒ String (readonly)

Returns The unique ID name of the instance of the stack.

Returns:

  • (String) —

    The unique ID name of the instance of the stack.



63
64
65
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 63

def stack_id
  @stack_id
end

#stack_name ⇒ String (readonly)

Returns The name associated with a stack.

Returns:

  • (String) —

    The name associated with a stack.



66
67
68
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 66

def stack_name
  @stack_name
end

#timestamp ⇒ Time (readonly)

Returns When the status was last updated.

Returns:

  • (Time) —

    When the status was last updated.



69
70
71
 
# File 'lib/aws/cloud_formation/stack_event.rb', line 69

def timestamp
  @timestamp
end