Class: Aws::EC2::PlacementGroup
- Inherits:
-
Object
- Object
- Aws::EC2::PlacementGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/placement_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #name ⇒ String (also: #group_name)
-
#partition_count ⇒ Integer
The number of partitions.
-
#state ⇒ String
The state of the placement group.
-
#strategy ⇒ String
The placement strategy.
Actions collapse
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #instances(options = {}) ⇒ Instance::Collection
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::PlacementGroup
Returns the data for this PlacementGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ PlacementGroup
constructor
A new instance of PlacementGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current PlacementGroup.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ PlacementGroup #initialize(options = {}) ⇒ PlacementGroup
Returns a new instance of PlacementGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
56 57 58 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 56 def client @client end |
#data ⇒ Types::PlacementGroup
Returns the data for this Aws::EC2::PlacementGroup. Calls Client#describe_placement_groups if #data_loaded? is ‘false`.
76 77 78 79 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 76 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
84 85 86 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 84 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
197 198 199 200 201 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 197 def delete( = {}) = .merge(group_name: @name) resp = @client.delete_placement_group() resp.data 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.
516 517 518 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 516 def identifiers { name: @name } end |
#instances(options = {}) ⇒ Instance::Collection
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 490 def instances( = {}) batches = Enumerator.new do |y| = Aws::Util.deep_merge(, filters: [{ name: "placement-group-name", values: [@name] }]) resp = @client.describe_instances() resp.each_page do |page| batch = [] page.data.reservations.each do |r| r.instances.each do |i| batch << Instance.new( id: i.instance_id, data: i, client: @client ) end end y.yield(batch) end end Instance::Collection.new(batches) end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::PlacementGroup. Returns ‘self` making it possible to chain methods.
placement_group.reload.data
66 67 68 69 70 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 66 def load resp = @client.describe_placement_groups(group_names: [@name]) @data = resp.placement_groups[0] self end |
#name ⇒ String Also known as: group_name
29 30 31 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 29 def name @name end |
#partition_count ⇒ Integer
The number of partitions. Valid only if strategy is set to ‘partition`.
49 50 51 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 49 def partition_count data[:partition_count] end |
#state ⇒ String
The state of the placement group.
36 37 38 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 36 def state data[:state] end |
#strategy ⇒ String
The placement strategy.
42 43 44 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 42 def strategy data[:strategy] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::EC2::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
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 166 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 |