Class: Aws::EC2::NetworkInterfaceAssociation

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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:



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

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)
  @waiter_block_warned = false
end

Instance Method Details

#addressVpcAddress?

Returns:



223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 223

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

#carrier_ipString

The carrier IP address associated with the network interface.

Returns:

  • (String)


39
40
41
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 39

def carrier_ip
  data[:carrier_ip]
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::InstanceNetworkInterfaceAssociation



88
89
90
91
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 88

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.



96
97
98
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 96

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)


214
215
216
217
218
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 214

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

#idString

Returns:

  • (String)


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

def id
  @id
end

#ip_owner_idString

The ID of the owner of the Elastic IP address.

Returns:

  • (String)


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

def ip_owner_id
  data[:ip_owner_id]
end

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


75
76
77
78
79
80
81
82
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 75

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

#public_dns_nameString

The public DNS name.

Returns:

  • (String)


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

def public_dns_name
  data[:public_dns_name]
end

#public_ipString

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

Returns:

  • (String)


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

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 180

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