Class: Aws::CloudFormation::StackResourceSummary
- Inherits:
-
Object
- Object
- Aws::CloudFormation::StackResourceSummary
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-cloudformation/stack_resource_summary.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#drift_information ⇒ Types::StackResourceDriftInformationSummary
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)
-
#physical_resource_id ⇒ String
The name or unique identifier that corresponds to a physical instance ID of the resource.
-
#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_name ⇒ String
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #resource ⇒ StackResource
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::StackResourceSummary
Returns the data for this StackResourceSummary.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ StackResourceSummary
constructor
A new instance of StackResourceSummary.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::CloudFormation::Client] #wait_until instead
Constructor Details
#initialize(stack_name, logical_id, options = {}) ⇒ StackResourceSummary #initialize(options = {}) ⇒ StackResourceSummary
Returns a new instance of StackResourceSummary.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.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
95 96 97 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 95 def client @client end |
#data ⇒ Types::StackResourceSummary
Returns the data for this Aws::CloudFormation::StackResourceSummary.
110 111 112 113 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 110 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
118 119 120 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 118 def data_loaded? !!@data end |
#drift_information ⇒ Types::StackResourceDriftInformationSummary
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
88 89 90 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 88 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.
230 231 232 233 234 235 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 230 def identifiers { stack_name: @stack_name, logical_id: @logical_id } end |
#last_updated_timestamp ⇒ Time
Time the status was updated.
62 63 64 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 62 def data[:last_updated_timestamp] end |
#load ⇒ Object Also known as: reload
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.
101 102 103 104 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 101 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#logical_id ⇒ String Also known as: logical_resource_id
37 38 39 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 37 def logical_id @logical_id end |
#physical_resource_id ⇒ String
The name or unique identifier that corresponds to a physical instance ID of the resource.
45 46 47 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 45 def physical_resource_id data[:physical_resource_id] end |
#resource ⇒ StackResource
220 221 222 223 224 225 226 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 220 def resource StackResource.new( logical_id: @logical_id, stack_name: @stack_name, client: @client ) end |
#resource_status ⇒ String
Current status of the resource.
68 69 70 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 68 def resource_status data[:resource_status] end |
#resource_status_reason ⇒ String
Success/failure message associated with the resource.
74 75 76 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 74 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
56 57 58 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 56 def resource_type data[:resource_type] end |
#stack_name ⇒ String
32 33 34 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.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
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/aws-sdk-cloudformation/stack_resource_summary.rb', line 200 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 |