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

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

Actions collapse

Associations collapse

Read-Only Attributes 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 'gems/aws-sdk-ec2/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

#addressVpcAddress?

Returns:



116
117
118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/network_interface_association.rb', line 116

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

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::InstanceNetworkInterfaceAssociation



78
79
80
81
# File 'gems/aws-sdk-ec2/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 'gems/aws-sdk-ec2/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)


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

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

#idString

Returns:

  • (String)


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

def id
  @id
end

#ip_owner_idString

The ID of the owner of the Elastic IP address.

Returns:

  • (String)


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

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)


65
66
67
68
69
70
71
72
# File 'gems/aws-sdk-ec2/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_nameString

The public DNS name.

Returns:

  • (String)


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

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)


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

def public_ip
  data.public_ip
end