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
-
#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.
-
#spread_level ⇒ String
The spread level for the placement group.
-
#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
- #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 = {}) {|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 '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
85 86 87 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 85 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`.
107 108 109 110 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 107 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
115 116 117 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 115 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
232 233 234 235 236 237 238 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 232 def delete( = {}) = .merge(group_name: @name) resp = Aws::Plugins::UserAgent.feature('resource') do @client.delete_placement_group() end resp.data end |
#group_arn ⇒ String
The Amazon Resource Name (ARN) of the placement group.
71 72 73 |
# File '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 'lib/aws-sdk-ec2/placement_group.rb', line 59 def group_id data[:group_id] 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.
718 719 720 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 718 def identifiers { name: @name } end |
#instances(options = {}) ⇒ Instance::Collection
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 690 def instances( = {}) batches = Enumerator.new do |y| = Aws::Util.deep_merge(, filters: [{ name: "placement-group-name", values: [@name] }]) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_instances() end 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
95 96 97 98 99 100 101 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 95 def load resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_placement_groups(group_names: [@name]) end @data = resp.placement_groups[0] self end |
#name ⇒ String Also known as: group_name
33 34 35 |
# File '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 'lib/aws-sdk-ec2/placement_group.rb', line 53 def partition_count data[:partition_count] end |
#spread_level ⇒ String
The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
78 79 80 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 78 def spread_level data[:spread_level] end |
#state ⇒ String
The state of the placement group.
40 41 42 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 40 def state data[:state] end |
#strategy ⇒ String
The placement strategy.
46 47 48 |
# File '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 '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
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/aws-sdk-ec2/placement_group.rb', line 199 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::Plugins::UserAgent.feature('resource') do Aws::Waiters::Waiter.new().wait({}) end end |