You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::ClassicAddress

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(public_ip, options = {}) ⇒ ClassicAddress #initialize(options = {}) ⇒ ClassicAddress

Returns a new instance of ClassicAddress

Overloads:

  • #initialize(public_ip, options = {}) ⇒ ClassicAddress

    Parameters:

    • public_ip (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ ClassicAddress

    Options Hash (options):

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


19
20
21
22
23
24
25
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 19

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

Instance Method Details

#allocation_idString

The ID representing the allocation of the address for use with EC2-VPC.

Returns:

  • (String)


43
44
45
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 43

def allocation_id
  data[:allocation_id]
end

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

Examples:

Request syntax with placeholder values


classic_address.associate({
  allocation_id: "AllocationId",
  instance_id: "InstanceId",
  allow_reassociation: false,
  dry_run: false,
  network_interface_id: "NetworkInterfaceId",
  private_ip_address: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :allocation_id (String)

    [EC2-VPC] The allocation ID. This is required for EC2-VPC.

  • :instance_id (String)

    The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

  • :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:



284
285
286
287
288
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 284

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

#association_idString

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

Returns:

  • (String)


50
51
52
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 50

def association_id
  data[:association_id]
end

#clientClient

Returns:



112
113
114
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 112

def client
  @client
end

#customer_owned_ipString

The customer-owned IP address.

Returns:

  • (String)


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

def customer_owned_ip
  data[:customer_owned_ip]
end

#customer_owned_ipv_4_poolString

The ID of the customer-owned address pool.

Returns:

  • (String)


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

def customer_owned_ipv_4_pool
  data[:customer_owned_ipv_4_pool]
end

#dataTypes::Address

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

Returns:



132
133
134
135
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 132

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.



140
141
142
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 140

def data_loaded?
  !!@data
end

#disassociate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


classic_address.disassociate({
  association_id: "ElasticIpAssociationId",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :association_id (String)

    [EC2-VPC] The association ID. Required for EC2-VPC.

  • :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)


305
306
307
308
309
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 305

def disassociate(options = {})
  options = options.merge(public_ip: data[:public_ip])
  resp = @client.disassociate_address(options)
  resp.data
end

#domainString

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

Returns:

  • (String)


57
58
59
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 57

def domain
  data[:domain]
end

#instance_idString

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

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 36

def instance_id
  data[:instance_id]
end

#loadself 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

Returns:

  • (self)


122
123
124
125
126
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 122

def load
  resp = @client.describe_addresses(public_ips: [@public_ip])
  @data = resp.addresses[0]
  self
end

#network_border_groupString

The name of the location from which the IP address is advertised.

Returns:

  • (String)


93
94
95
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 93

def network_border_group
  data[:network_border_group]
end

#network_interface_idString

The ID of the network interface.

Returns:

  • (String)


63
64
65
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 63

def network_interface_id
  data[:network_interface_id]
end

#network_interface_owner_idString

The ID of the AWS account that owns the network interface.

Returns:

  • (String)


69
70
71
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 69

def network_interface_owner_id
  data[:network_interface_owner_id]
end

#private_ip_addressString

The private IP address associated with the Elastic IP address.

Returns:

  • (String)


75
76
77
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 75

def private_ip_address
  data[:private_ip_address]
end

#public_ipString

Returns:

  • (String)


30
31
32
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 30

def public_ip
  @public_ip
end

#public_ipv_4_poolString

The ID of an address pool.

Returns:

  • (String)


87
88
89
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 87

def public_ipv_4_pool
  data[:public_ipv_4_pool]
end

#release(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


classic_address.release({
  allocation_id: "AllocationId",
  network_border_group: "String",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :allocation_id (String)

    [EC2-VPC] The allocation ID. Required for EC2-VPC.

  • :network_border_group (String)

    The location that the IP address is released from.

    If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes.

    You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

  • :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)


344
345
346
347
348
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 344

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

#tagsArray<Types::Tag>

Any tags assigned to the Elastic IP address.

Returns:



81
82
83
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 81

def tags
  data[:tags]
end

#wait_until(options = {}, &block) ⇒ 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) {|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

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

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/classic_address.rb', line 222

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