Class: Aws::EC2::ClassicAddress
- Inherits:
-
Object
- Object
- Aws::EC2::ClassicAddress
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#allocation_id ⇒ String
The ID representing the allocation of the address for use with EC2-VPC.
-
#association_id ⇒ String
The ID representing the association of the address with an instance in a VPC.
-
#carrier_ip ⇒ String
The carrier IP address associated.
-
#customer_owned_ip ⇒ String
The customer-owned IP address.
-
#customer_owned_ipv_4_pool ⇒ String
The ID of the customer-owned address pool.
-
#domain ⇒ String
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (
standard
) or instances in a VPC (vpc
). -
#instance_id ⇒ String
The ID of the instance that the address is associated with (if any).
-
#network_border_group ⇒ String
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
-
#network_interface_id ⇒ String
The ID of the network interface.
-
#network_interface_owner_id ⇒ String
The ID of the AWS account that owns the network interface.
-
#private_ip_address ⇒ String
The private IP address associated with the Elastic IP address.
-
#public_ip ⇒ String
-
#public_ipv_4_pool ⇒ String
The ID of an address pool.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the Elastic IP address.
Actions collapse
-
#associate(options = {}) ⇒ Types::AssociateAddressResult
-
#disassociate(options = {}) ⇒ EmptyStructure
-
#release(options = {}) ⇒ EmptyStructure
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::Address
Returns the data for this ClassicAddress.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ ClassicAddress
constructor
A new instance of ClassicAddress.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current ClassicAddress.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(public_ip, options = {}) ⇒ ClassicAddress #initialize(options = {}) ⇒ ClassicAddress
Returns a new instance of ClassicAddress.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @public_ip = extract_public_ip(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#allocation_id ⇒ String
The ID representing the allocation of the address for use with EC2-VPC.
46 47 48 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 46 def allocation_id data[:allocation_id] end |
#associate(options = {}) ⇒ Types::AssociateAddressResult
298 299 300 301 302 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 298 def associate( = {}) = .merge(public_ip: @public_ip) resp = @client.associate_address() resp.data end |
#association_id ⇒ String
The ID representing the association of the address with an instance in a VPC.
53 54 55 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 53 def association_id data[:association_id] end |
#carrier_ip ⇒ String
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
117 118 119 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 117 def carrier_ip data[:carrier_ip] end |
#client ⇒ Client
124 125 126 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 124 def client @client end |
#customer_owned_ip ⇒ String
The customer-owned IP address.
103 104 105 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 103 def customer_owned_ip data[:customer_owned_ip] end |
#customer_owned_ipv_4_pool ⇒ String
The ID of the customer-owned address pool.
109 110 111 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 109 def customer_owned_ipv_4_pool data[:customer_owned_ipv_4_pool] end |
#data ⇒ Types::Address
Returns the data for this Aws::EC2::ClassicAddress. Calls
Aws::EC2::Client#describe_addresses if #data_loaded? is false
.
144 145 146 147 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 144 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
152 153 154 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 152 def data_loaded? !!@data end |
#disassociate(options = {}) ⇒ EmptyStructure
319 320 321 322 323 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 319 def disassociate( = {}) = .merge(public_ip: data[:public_ip]) resp = @client.disassociate_address() resp.data end |
#domain ⇒ String
Indicates whether this Elastic IP address is for use with instances in
EC2-Classic (standard
) or instances in a VPC (vpc
).
60 61 62 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 60 def domain data[:domain] end |
#instance_id ⇒ String
The ID of the instance that the address is associated with (if any).
39 40 41 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 39 def instance_id data[:instance_id] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::ClassicAddress.
Returns self
making it possible to chain methods.
classic_address.reload.data
134 135 136 137 138 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 134 def load resp = @client.describe_addresses(public_ips: [@public_ip]) @data = resp.addresses[0] self end |
#network_border_group ⇒ String
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
97 98 99 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 97 def network_border_group data[:network_border_group] end |
#network_interface_id ⇒ String
The ID of the network interface.
66 67 68 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 66 def network_interface_id data[:network_interface_id] end |
#network_interface_owner_id ⇒ String
The ID of the AWS account that owns the network interface.
72 73 74 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 72 def network_interface_owner_id data[:network_interface_owner_id] end |
#private_ip_address ⇒ String
The private IP address associated with the Elastic IP address.
78 79 80 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 78 def private_ip_address data[:private_ip_address] end |
#public_ip ⇒ String
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 33 def public_ip @public_ip end |
#public_ipv_4_pool ⇒ String
The ID of an address pool.
90 91 92 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 90 def public_ipv_4_pool data[:public_ipv_4_pool] end |
#release(options = {}) ⇒ EmptyStructure
359 360 361 362 363 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 359 def release( = {}) = .merge(public_ip: data[:public_ip]) resp = @client.release_address() resp.data end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the Elastic IP address.
84 85 86 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 84 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
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 236 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 |