Class: Aws::EC2::DhcpOptions
- Inherits:
-
Object
- Object
- Aws::EC2::DhcpOptions
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/dhcp_options.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#dhcp_configurations ⇒ Array<Types::DhcpConfiguration>
One or more DHCP options in the set.
- #id ⇒ String (also: #dhcp_options_id)
-
#owner_id ⇒ String
The ID of the AWS account that owns the DHCP options set.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the DHCP options set.
Actions collapse
- #associate_with_vpc(options = {}) ⇒ EmptyStructure
- #create_tags(options = {}) ⇒ Tag::Collection
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DhcpOptions
Returns the data for this DhcpOptions.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DhcpOptions
constructor
A new instance of DhcpOptions.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DhcpOptions.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ DhcpOptions #initialize(options = {}) ⇒ DhcpOptions
Returns a new instance of DhcpOptions.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#associate_with_vpc(options = {}) ⇒ EmptyStructure
199 200 201 202 203 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 199 def associate_with_vpc( = {}) = .merge(dhcp_options_id: @id) resp = @client.() resp.data end |
#create_tags(options = {}) ⇒ Tag::Collection
227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 227 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = @client.() [:tags].each do |t| batch << Tag.new( resource_id: @id, key: t[:key], value: t[:value], client: @client ) end Tag::Collection.new([batch], size: batch.size) end |
#data ⇒ Types::DhcpOptions
Returns the data for this Aws::EC2::DhcpOptions. Calls Client#describe_dhcp_options if #data_loaded? is ‘false`.
75 76 77 78 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 75 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
83 84 85 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 83 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
254 255 256 257 258 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 254 def delete( = {}) = .merge(dhcp_options_id: @id) resp = @client.() resp.data end |
#dhcp_configurations ⇒ Array<Types::DhcpConfiguration>
One or more DHCP options in the set.
36 37 38 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 36 def dhcp_configurations data[:dhcp_configurations] end |
#id ⇒ String Also known as: dhcp_options_id
29 30 31 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 29 def id @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.
262 263 264 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 262 def identifiers { id: @id } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::DhcpOptions. Returns ‘self` making it possible to chain methods.
.reload.data
65 66 67 68 69 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 65 def load resp = @client.(dhcp_options_ids: [@id]) @data = resp.[0] self end |
#owner_id ⇒ String
The ID of the AWS account that owns the DHCP options set.
42 43 44 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 42 def owner_id data[:owner_id] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the DHCP options set.
48 49 50 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 48 def data[:tags] 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
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/aws-sdk-ec2/dhcp_options.rb', line 165 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 |