Class: AWS::CloudFormation::StackResource

Inherits:
AWS::Core::Resource show all
Defined in:
lib/aws/cloud_formation/stack_resource.rb

Instance Attribute Summary collapse

Attributes included from AWS::Core::Model

#config

Instance Method Summary collapse

Methods inherited from AWS::Core::Resource

attribute_providers, attribute_providers_for, attributes, #attributes_from_response, define_attribute_type, #eql?, #inspect, new_from

Methods included from AWS::Core::Cacheable

included, #retrieve_attribute

Methods included from AWS::Core::Model

#client, #config_prefix, #inspect

Constructor Details

#initialize(stack, logical_resource_id, options = {}) ⇒ StackResource

Returns a new instance of StackResource.



49
50
51
52
53
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 49

def initialize stack, logical_resource_id, options = {}
  @stack = stack
  @logical_resource_id = logical_resource_id
  super
end

Instance Attribute Details

#description ⇒ String? (readonly)

User defined description associated with the resource.

Returns:

  • (String, nil) —

    the current value of description



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def description
  @description
end

#last_updated_timestamp ⇒ Time (readonly)

When the status was last updated.

Returns:

  • (Time) —

    the current value of last_updated_timestamp



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def last_updated_timestamp
  @last_updated_timestamp
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.



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

def logical_resource_id
  @logical_resource_id
end

#metadata ⇒ String? (readonly)

The JSON format content of the Metadata attribute declared for the resource.

Returns:

  • (String, nil) —

    the current value of metadata



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def metadata
  @metadata
end

#physical_resource_id ⇒ String (readonly)

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

Returns:

  • (String) —

    the current value of physical_resource_id



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def physical_resource_id
  @physical_resource_id
end

#resource_status ⇒ Symbol (readonly)

Current status of the resource.

Returns:

  • (Symbol) —

    the current value of resource_status



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def resource_status
  @resource_status
end

#resource_status_reason ⇒ String? (readonly)

Success/failure message associated with the resource.

Returns:

  • (String, nil) —

    the current value of resource_status_reason



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def resource_status_reason
  @resource_status_reason
end

#resource_type ⇒ String (readonly)

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

Returns:

  • (String) —

    the current value of resource_type



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def resource_type
  @resource_type
end

#stack ⇒ Stack (readonly)

Returns:



56
57
58
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 56

def stack
  @stack
end

#stack_id ⇒ String (readonly)

Unique identifier of the stack.

Returns:

  • (String) —

    the current value of stack_id



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def stack_id
  @stack_id
end

#stack_name ⇒ String (readonly)

The name associated with the stack.

Returns:

  • (String) —

    the current value of stack_name



46
47
48
 
# File 'lib/aws/cloud_formation/stack_resource.rb', line 46

def stack_name
  @stack_name
end