Class: Aws::CloudFormation::StackResource

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-cloudformation/stack_resource.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(stack_name, logical_id, options = {}) ⇒ StackResource #initialize(options = {}) ⇒ StackResource

Returns a new instance of StackResource.

Overloads:

  • #initialize(stack_name, logical_id, options = {}) ⇒ StackResource

    Parameters:

    • stack_name (String)
    • logical_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ StackResource

    Options Hash (options):

    • :stack_name (required, String)
    • :logical_id (required, String)
    • :client (Client) 


21
22
23
24
25
26
27
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 21

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

Instance Method Details

#client ⇒ Client

Returns:



105
106
107
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 105

def client
  @client
end

#data ⇒ Types::StackResourceDetail

Returns the data for this Aws::CloudFormation::StackResource. Calls Client#describe_stack_resource if #data_loaded? is ‘false`.

Returns:



128
129
130
131
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 128

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.



136
137
138
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 136

def data_loaded?
  !!@data
end

#description ⇒ String

User defined description associated with the resource.

Returns:

  • (String) 


86
87
88
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 86

def description
  data.description
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


152
153
154
155
156
157
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 152

def identifiers
  {
    stack_name: @stack_name,
    logical_id: @logical_id
  }
end

#last_updated_timestamp ⇒ Time

Time the status was updated.

Returns:

  • (Time) 


68
69
70
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 68

def last_updated_timestamp
  data.last_updated_timestamp
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::CloudFormation::StackResource. Returns ‘self` making it possible to chain methods.

stack_resource.reload.data

Returns:

  • (self) 


115
116
117
118
119
120
121
122
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 115

def load
  resp = @client.describe_stack_resource(
    logical_resource_id: @logical_id,
    stack_name: @stack_name
  )
  @data = resp.stack_resource_detail
  self
end

#logical_id ⇒ String Also known as: logical_resource_id

Returns:

  • (String) 


37
38
39
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 37

def logical_id
  @logical_id
end

#metadata ⇒ String

The content of the ‘Metadata` attribute declared for the resource. For more information, see [Metadata Attribute] in the AWS CloudFormation User Guide.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

Returns:

  • (String) 


98
99
100
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 98

def metadata
  data.metadata
end

#physical_resource_id ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 51

def physical_resource_id
  data.physical_resource_id
end

#resource_status ⇒ String

Current status of the resource.

Returns:

  • (String) 


74
75
76
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 74

def resource_status
  data.resource_status
end

#resource_status_reason ⇒ String

Success/failure message associated with the resource.

Returns:

  • (String) 


80
81
82
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 80

def resource_status_reason
  data.resource_status_reason
end

#resource_type ⇒ String

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

  • (String) 


62
63
64
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 62

def resource_type
  data.resource_type
end

#stack ⇒ Stack

Returns:



143
144
145
146
147
148
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 143

def stack
  Stack.new(
    name: @stack_name,
    client: @client
  )
end

#stack_id ⇒ String

Unique identifier of the stack.

Returns:

  • (String) 


44
45
46
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 44

def stack_id
  data.stack_id
end

#stack_name ⇒ String

Returns:

  • (String) 


32
33
34
 
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 32

def stack_name
  @stack_name
end