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

Class: AWS::EC2::NetworkInterface

Inherits:
Resource
  • Object
show all
Includes:
TaggedItem
Defined in:
lib/aws/ec2/network_interface.rb,
lib/aws/ec2/network_interface/attachment.rb

Overview

Represents a network interface in EC2.

Defined Under Namespace

Classes: Attachment

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TaggedItem

#add_tag, #clear_tags, #tags

Constructor Details

#initialize(network_interface_id, options = {}) ⇒ NetworkInterface

Returns a new instance of NetworkInterface



56
57
58
59
 
# File 'lib/aws/ec2/network_interface.rb', line 56

def initialize network_interface_id, options = {}
  @network_interface_id = network_interface_id
  super
end

Instance Attribute Details

#association ⇒ Hash? (readonly)

Returns a hash of details about the association between this network interface and an elastic ip address.

Returns:

  • (Hash, nil) —

    the current value of association



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def association
  @association
end

#availability_zone_name ⇒ String (readonly)

Returns the current value of availability_zone_name

Returns:

  • (String) —

    the current value of availability_zone_name



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def availability_zone_name
  @availability_zone_name
end

#description ⇒ String

Returns the current value of description

Returns:

  • (String) —

    the current value of description



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def description
  @description
end

#mac_address ⇒ String (readonly)

Returns the current value of mac_address

Returns:

  • (String) —

    the current value of mac_address



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def mac_address
  @mac_address
end

#network_interface_id ⇒ String (readonly) Also known as: id

Returns:

  • (String) 


62
63
64
 
# File 'lib/aws/ec2/network_interface.rb', line 62

def network_interface_id
  @network_interface_id
end

#owner_id ⇒ String (readonly)

Returns the current value of owner_id

Returns:

  • (String) —

    the current value of owner_id



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def owner_id
  @owner_id
end

#private_dns_name ⇒ String (readonly)

Returns the current value of private_dns_name

Returns:

  • (String) —

    the current value of private_dns_name



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def private_dns_name
  @private_dns_name
end

#private_ip_address ⇒ String (readonly)

Returns the current value of private_ip_address

Returns:

  • (String) —

    the current value of private_ip_address



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def private_ip_address
  @private_ip_address
end

#private_ip_addresses ⇒ Array<Hash> (readonly)

Returns an array of private ip addresses with the following keys: * :private_ip_address (String) * :primary (boolean)

Returns:

  • (Array<Hash>) —

    the current value of private_ip_addresses



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def private_ip_addresses
  @private_ip_addresses
end

#requester_managed ⇒ Boolean Also known as: requester_managed?

Returns the current value of requester_managed

Returns:

  • (Boolean) —

    the current value of requester_managed



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def requester_managed
  @requester_managed
end

#source_dest_check ⇒ Boolean Also known as: source_dest_check?

Returns the current value of source_dest_check

Returns:

  • (Boolean) —

    the current value of source_dest_check



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def source_dest_check
  @source_dest_check
end

#status ⇒ Symbol (readonly)

Returns the current value of status

Returns:

  • (Symbol) —

    the current value of status



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def status
  @status
end

#subnet_id ⇒ String (readonly)

Returns the current value of subnet_id

Returns:

  • (String) —

    the current value of subnet_id



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def subnet_id
  @subnet_id
end

#vpc_id ⇒ String (readonly)

Returns the current value of vpc_id

Returns:

  • (String) —

    the current value of vpc_id



52
53
54
 
# File 'lib/aws/ec2/network_interface.rb', line 52

def vpc_id
  @vpc_id
end

Instance Method Details

#attach(instance, options = {}) ⇒ nil

Parameters:

  • instance (Instance, String) —

    The instance to attach this network interface to, may be an Instance object or an instance id string.

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

Options Hash (options):

  • :device_index (Integer) — default: 1 —

    The index of the device for the network interface attachment on the instance. Defaults to 1.

Returns:

  • (nil) 


189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/aws/ec2/network_interface.rb', line 189

def attach instance, options = {}

  instance_id = instance.is_a?(Instance) ? instance.instance_id : instance

  client_opts = {}
  client_opts[:network_interface_id] = network_interface_id
  client_opts[:instance_id] = instance_id
  client_opts[:device_index] = options[:device_index] || 1

  client.attach_network_interface(client_opts)

  nil

end

#attachment ⇒ Attachment?

Returns:



173
174
175
176
177
 
# File 'lib/aws/ec2/network_interface.rb', line 173

def attachment
  if details = attachment_details
    Attachment.new(self, details)
  end
end

#availability_zone ⇒ AvailabilityZone

Returns:



138
139
140
 
# File 'lib/aws/ec2/network_interface.rb', line 138

def availability_zone
  AvailabilityZone.new(availability_zone_name, :config => config)
end

#delete ⇒ nil

Deletes this network interface.

Returns:

  • (nil) 


218
219
220
221
222
223
 
# File 'lib/aws/ec2/network_interface.rb', line 218

def delete
  client_opts = {}
  client_opts[:network_interface_id] = network_interface_id
  client.delete_network_interface(client_opts)
  nil
end

#detach(options = {}) ⇒ nil

Detaches this network interface.

Parameters:

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

Options Hash (options):

  • :force (Boolean) — default: false —

    Set true to force a detachment.

Returns:

  • (nil) 


208
209
210
211
212
213
214
 
# File 'lib/aws/ec2/network_interface.rb', line 208

def detach options = {}
  if attachment = self.attachment
    attachment.detach(options)
  else
    raise 'unable to detach network interface, no attachment present'
  end
end

#elastic_ip ⇒ ElasticIp?

Returns:



130
131
132
133
134
135
 
# File 'lib/aws/ec2/network_interface.rb', line 130

def elastic_ip
  if association = self.association
    opts = association.merge(:config => config)
    ElasticIp.new(association[:public_ip], opts)
  end
end

#exists? ⇒ Boolean

Returns true if this network interface exists.

Returns:

  • (Boolean) —

    Returns true if this network interface exists.



226
227
228
229
230
231
232
233
 
# File 'lib/aws/ec2/network_interface.rb', line 226

def exists?
  begin
    get_resource
    true
  rescue Errors::InvalidNetworkInterfaceID::NotFound
    false
  end
end

#instance ⇒ Instance?

Returns the instance this network interface is attached to. If it has not been attached, then nil is returned.

Returns:

  • (Instance, nil) —

    Returns the instance this network interface is attached to. If it has not been attached, then nil is returned.



166
167
168
169
170
 
# File 'lib/aws/ec2/network_interface.rb', line 166

def instance
  if attachment = self.attachment
    attachment.instance
  end
end

#security_groups ⇒ Array<SecurityGroup>

Returns:



143
144
145
146
147
 
# File 'lib/aws/ec2/network_interface.rb', line 143

def security_groups
  groups.collect do |g|
    SecurityGroup.new(g.group_id, :name => g.group_name, :config => config)
  end
end

#set_security_groups(*groups) ⇒ nil Also known as: security_groups=

Parameters:

  • groups (Array<SecurityGroup>, Array<String>) —

    A list of security groups objects or security group ids. This replaces the security group set on this network interface.

Returns:

  • (nil) 


155
156
157
158
159
160
 
# File 'lib/aws/ec2/network_interface.rb', line 155

def set_security_groups *groups
  self.groups = [groups].flatten.collect do |g|
    g.is_a?(SecurityGroup) ? g.security_group_id : g
  end
  nil
end

#subnet ⇒ Subnet

Returns the Subnet this network interface belongs to.

Returns:

  • (Subnet) —

    Returns the Subnet this network interface belongs to.



125
126
127
 
# File 'lib/aws/ec2/network_interface.rb', line 125

def subnet
  Subnet.new(subnet_id, :vpc_id => vpc_id, :config => config)
end

#vpc ⇒ VPC

Returns the VPC this network interface belongs to.

Returns:

  • (VPC) —

    Returns the VPC this network interface belongs to.



119
120
121
 
# File 'lib/aws/ec2/network_interface.rb', line 119

def vpc
  VPC.new(vpc_id, :config => config)
end