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

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

Actions collapse

Associations collapse

Read-Only Attributes 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)


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

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

Instance Method Details

#allocation_idString

Returns:

  • (String)


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

def allocation_id
  @allocation_id
end

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

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

  • :public_ip (String)

    The Elastic IP address. 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.

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



249
250
251
252
253
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 249

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

#associationNetworkInterfaceAssociation?

Returns:



279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 279

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

#association_idString

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

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 48

def association_id
  data[:association_id]
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::Address

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

Returns:



100
101
102
103
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 100

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.



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

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


55
56
57
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 55

def domain
  data[:domain]
end

#instance_idString

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

Returns:

  • (String)


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

def instance_id
  data[:instance_id]
end

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


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

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

#network_interface_idString

The ID of the network interface.

Returns:

  • (String)


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

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)


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

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)


73
74
75
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 73

def private_ip_address
  data[:private_ip_address]
end

#public_ipString

The Elastic IP address.

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 41

def public_ip
  data[:public_ip]
end

#release(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


vpc_address.release({
  public_ip: "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.

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


270
271
272
273
274
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 270

def release(options = {})
  options = options.merge(allocation_id: data[:allocation_id])
  resp = @client.release_address(options)
  resp.data
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_address.rb', line 190

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