Class: Aws::EC2::NetworkInterfaceAssociation

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-ec2/network_interface_association.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ NetworkInterfaceAssociation #initialize(options = {}) ⇒ NetworkInterfaceAssociation

Returns a new instance of NetworkInterfaceAssociation.

Overloads:



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

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

Instance Method Details

#address ⇒ VpcAddress?

Returns:



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/aws-sdk-ec2/network_interface_association.rb', line 211

def address
  if data[:allocation_id]
    VpcAddress.new(
      allocation_id: data[:allocation_id],
      client: @client
    )
  else
    nil
  end
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ Types::InstanceNetworkInterfaceAssociation

Returns the data for this Aws::EC2::NetworkInterfaceAssociation. Calls Client#describe_network_interfaces if #data_loaded? is ‘false`.

Returns:



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

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.



86
87
88
 
# File 'lib/aws-sdk-ec2/network_interface_association.rb', line 86

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


network_interface_association.delete({
  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) 


202
203
204
205
206
 
# File 'lib/aws-sdk-ec2/network_interface_association.rb', line 202

def delete(options = {})
  options = options.merge(association_id: @id)
  resp = @client.disassociate_address(options)
  resp.data
end

#id ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/aws-sdk-ec2/network_interface_association.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.

Deprecated. 


224
225
226
 
# File 'lib/aws-sdk-ec2/network_interface_association.rb', line 224

def identifiers
  { id: @id }
end

#ip_owner_id ⇒ String

The ID of the owner of the Elastic IP address.

Returns:

  • (String) 


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

def ip_owner_id
  data[:ip_owner_id]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::EC2::NetworkInterfaceAssociation. Returns ‘self` making it possible to chain methods.

network_interface_association.reload.data

Returns:

  • (self) 


65
66
67
68
69
70
71
72
 
# File 'lib/aws-sdk-ec2/network_interface_association.rb', line 65

def load
  resp = @client.describe_network_interfaces(filters: [{
    name: "association.association-id",
    values: [@id]
  }])
  @data = resp.network_interfaces[0].association
  self
end

#public_dns_name ⇒ String

The public DNS name.

Returns:

  • (String) 


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

def public_dns_name
  data[:public_dns_name]
end

#public_ip ⇒ String

The public IP address or Elastic IP address bound to the network interface.

Returns:

  • (String) 


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

def public_ip
  data[:public_ip]
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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/aws-sdk-ec2/network_interface_association.rb', line 168

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