Class: Aws::EC2::PlacementGroup
- Inherits:
-
Object
- Object
- Aws::EC2::PlacementGroup
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#group_arn ⇒ String
The Amazon Resource Name (ARN) of the placement group.
-
#group_id ⇒ String
The ID of the placement group.
-
#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.
-
#tags ⇒ Array<Types::Tag>
Any tags applied to the placement group.
Actions collapse
Associations collapse
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 = {}) {|resource| ... } ⇒ 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.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#client ⇒ Client
78 79 80 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 78 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
.
98 99 100 101 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 98 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
106 107 108 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 106 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
221 222 223 224 225 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 221 def delete( = {}) = .merge(group_name: @name) resp = @client.delete_placement_group() resp.data end |
#group_arn ⇒ String
The Amazon Resource Name (ARN) of the placement group.
71 72 73 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 71 def group_arn data[:group_arn] end |
#group_id ⇒ String
The ID of the placement group.
59 60 61 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 59 def group_id data[:group_id] end |
#instances(options = {}) ⇒ Instance::Collection
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 535 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
88 89 90 91 92 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 88 def load resp = @client.describe_placement_groups(group_names: [@name]) @data = resp.placement_groups[0] self end |
#name ⇒ String Also known as: group_name
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 33 def name @name end |
#partition_count ⇒ Integer
The number of partitions. Valid only if strategy is set to
partition
.
53 54 55 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 53 def partition_count data[:partition_count] end |
#state ⇒ String
The state of the placement group.
40 41 42 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 40 def state data[:state] end |
#strategy ⇒ String
The placement strategy.
46 47 48 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 46 def strategy data[:strategy] end |
#tags ⇒ Array<Types::Tag>
Any tags applied to the placement group.
65 66 67 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 65 def data[:tags] end |
#wait_until(options = {}) {|resource| ... } ⇒ 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) do |instance|
instance.state.name == 'running'
end
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
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/placement_group.rb', line 190 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 |