Class: Aws::EC2::VpcAddress

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(allocation_id, options = {}) ⇒ VpcAddress #initialize(options = {}) ⇒ VpcAddress

Returns a new instance of VpcAddress.

Overloads:

  • #initialize(allocation_id, options = {}) ⇒ VpcAddress

    Parameters:

    • allocation_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ VpcAddress

    Options Hash (options):

    • :allocation_id (required, String)
    • :client (Client) 

22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @allocation_id = extract_allocation_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#allocation_id ⇒ String

Returns:

  • (String) 

33
34
35
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 33

def allocation_id
  @allocation_id
end

#associate(options = {}) ⇒ Types::AssociateAddressResult

Examples:

Request syntax with placeholder values


vpc_address.associate({
  instance_id: "InstanceId",
  public_ip: "String",
  allow_reassociation: false,
  dry_run: false,
  network_interface_id: "NetworkInterfaceId",
  private_ip_address: "String",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :instance_id (String) —

    The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.

  • :public_ip (String) —

    [EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.

  • :allow_reassociation (Boolean) —

    [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :network_interface_id (String) —

    [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

    For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

  • :private_ip_address (String) —

    [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

Returns:


300
301
302
303
304
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 300

def associate(options = {})
  options = options.merge(allocation_id: @allocation_id)
  resp = @client.associate_address(options)
  resp.data
end

#association ⇒ NetworkInterfaceAssociation?

Returns:


341
342
343
344
345
346
347
348
349
350
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 341

def association
  if data[:association_id]
    NetworkInterfaceAssociation.new(
      id: data[:association_id],
      client: @client
    )
  else
    nil
  end
end

#association_id ⇒ String

The ID representing the association of the address with an instance in a VPC.

Returns:

  • (String) 

52
53
54
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 52

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).

Returns:

  • (String) 

118
119
120
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 118

def carrier_ip
  data[:carrier_ip]
end

#client ⇒ Client

Returns:


125
126
127
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 125

def client
  @client
end

#customer_owned_ip ⇒ String

The customer-owned IP address.

Returns:

  • (String) 

104
105
106
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 104

def customer_owned_ip
  data[:customer_owned_ip]
end

#customer_owned_ipv_4_pool ⇒ String

The ID of the customer-owned address pool.

Returns:

  • (String) 

110
111
112
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 110

def customer_owned_ipv_4_pool
  data[:customer_owned_ipv_4_pool]
end

#data ⇒ Types::Address

Returns the data for this Aws::EC2::VpcAddress. Calls Client#describe_addresses if #data_loaded? is false.

Returns:


145
146
147
148
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 145

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.


153
154
155
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 153

def data_loaded?
  !!@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).

Returns:

  • (String) 

59
60
61
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 59

def domain
  data[:domain]
end

#instance_id ⇒ String

The ID of the instance that the address is associated with (if any).

Returns:

  • (String) 

39
40
41
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_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::VpcAddress. Returns self making it possible to chain methods.

vpc_address.reload.data

Returns:

  • (self) 

135
136
137
138
139
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 135

def load
  resp = @client.describe_addresses(allocation_ids: [@allocation_id])
  @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 Amazon Web Services advertises IP addresses.

Returns:

  • (String) 

98
99
100
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 98

def network_border_group
  data[:network_border_group]
end

#network_interface_id ⇒ String

The ID of the network interface.

Returns:

  • (String) 

65
66
67
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 65

def network_interface_id
  data[:network_interface_id]
end

#network_interface_owner_id ⇒ String

The ID of the Amazon Web Services account that owns the network interface.

Returns:

  • (String) 

72
73
74
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_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.

Returns:

  • (String) 

78
79
80
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 78

def private_ip_address
  data[:private_ip_address]
end

#public_ip ⇒ String

The Elastic IP address.

Returns:

  • (String) 

45
46
47
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 45

def public_ip
  data[:public_ip]
end

#public_ipv_4_pool ⇒ String

The ID of an address pool.

Returns:

  • (String) 

90
91
92
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 90

def public_ipv_4_pool
  data[:public_ipv_4_pool]
end

#release(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


vpc_address.release({
  public_ip: "String",
  network_border_group: "String",
  dry_run: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :public_ip (String) —

    [EC2-Classic] The Elastic IP address. Required for EC2-Classic.

  • :network_border_group (String) —

    The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

    If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

    You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure) 

332
333
334
335
336
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 332

def release(options = {})
  options = options.merge(allocation_id: data[:allocation_id])
  resp = @client.release_address(options)
  resp.data
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the Elastic IP address.

Returns:


84
85
86
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 84

def tags
  data[:tags]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

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(options) {|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

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 237

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end