Class: Aws::CloudFormation::StackResource
- Inherits:
-
Object
- Object
- Aws::CloudFormation::StackResource
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-cloudformation/stack_resource.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#description ⇒ String
User defined description associated with the resource.
-
#drift_information ⇒ Types::StackResourceDriftInformation
Information about whether the resource’s actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.
-
#last_updated_timestamp ⇒ Time
Time the status was updated.
- #logical_id ⇒ String (also: #logical_resource_id)
-
#metadata ⇒ String
The content of the ‘Metadata` attribute declared for the resource.
-
#physical_resource_id ⇒ String
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
-
#resource_status ⇒ String
Current status of the resource.
-
#resource_status_reason ⇒ String
Success/failure message associated with the resource.
-
#resource_type ⇒ String
Type of resource.
-
#stack_id ⇒ String
Unique identifier of the stack.
- #stack_name ⇒ String
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #stack ⇒ Stack
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::StackResourceDetail
Returns the data for this StackResource.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ StackResource
constructor
A new instance of StackResource.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current StackResource.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::CloudFormation::Client] #wait_until instead
Constructor Details
#initialize(stack_name, logical_id, options = {}) ⇒ StackResource #initialize(options = {}) ⇒ StackResource
Returns a new instance of StackResource.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 21 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @stack_name = extract_stack_name(args, ) @logical_id = extract_logical_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
119 120 121 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 119 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`.
142 143 144 145 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 142 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
150 151 152 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 150 def data_loaded? !!@data end |
#description ⇒ String
User defined description associated with the resource.
86 87 88 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 86 def description data[:description] end |
#drift_information ⇒ Types::StackResourceDriftInformation
Information about whether the resource’s actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see [Detecting Unregulated Configuration Changes to Stacks and Resources].
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
112 113 114 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 112 def drift_information data[:drift_information] 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.
261 262 263 264 265 266 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 261 def identifiers { stack_name: @stack_name, logical_id: @logical_id } end |
#last_updated_timestamp ⇒ Time
Time the status was updated.
68 69 70 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 68 def 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
129 130 131 132 133 134 135 136 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 129 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
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
98 99 100 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 98 def 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.
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.
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.
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
62 63 64 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 62 def resource_type data[:resource_type] end |
#stack ⇒ Stack
252 253 254 255 256 257 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 252 def stack Stack.new( name: @stack_name, client: @client ) end |
#stack_id ⇒ String
Unique identifier of the stack.
44 45 46 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 44 def stack_id data[:stack_id] end |
#stack_name ⇒ String
32 33 34 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 32 def stack_name @stack_name end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::CloudFormation::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged
Waiter polls an API operation until a resource enters a desired state.
## 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() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
## 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
attempts attempt in seconds invoked before each attempt invoked before each wait
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/aws-sdk-cloudformation/stack_resource.rb', line 232 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |