-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
Copy pathnetwork_interface.rb
237 lines (191 loc) · 6.58 KB
/
network_interface.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
require 'aws/ec2/network_interface/attachment'
module AWS
class EC2
# Represents a network interface in EC2.
#
# @attr [String] description
#
# @attr_reader [String] vpc_id
#
# @attr_reader [String] subnet_id
#
# @attr_reader [String] owner_id
#
# @attr_reader [Symbol] status
#
# @attr_reader [String] private_ip_address
#
# @attr_reader [Array<Hash>] private_ip_addresses Returns an array
# of private ip addresses with the following keys:
# * `:private_ip_address` (String)
# * `:primary` (boolean)
#
# @attr_reader [String] private_dns_name
#
# @attr_reader [String] availability_zone_name
#
# @attr_reader [String] mac_address
#
# @attr_reader [Hash,nil] association Returns a hash of
# details about the association between this network interface
# and an elastic ip address.
#
# @attr [Boolean] source_dest_check
#
# @attr [Boolean] requester_managed
#
class NetworkInterface < Resource
include TaggedItem
def initialize network_interface_id, options = {}
@network_interface_id = network_interface_id
super
end
# @return [String]
attr_reader :network_interface_id
alias_method :id, :network_interface_id
attribute :vpc_id, :static => true
attribute :subnet_id, :static => true
mutable_attribute :description
attribute :owner_id, :static => true
attribute :status, :to_sym => true
attribute :private_ip_address, :static => true
attribute :private_ip_addresses,
:from => :private_ip_addresses_set,
:static => true
attribute :private_dns_name, :static => true
attribute :mac_address, :static => true
attribute :availability_zone_name,
:from => :availability_zone,
:static => true
mutable_attribute :source_dest_check
alias_method :source_dest_check?, :source_dest_check
attribute :requester_managed
alias_method :requester_managed?, :requester_managed
attribute :association do
translates_output {|assoc| assoc.to_hash }
end
attribute :attachment_details, :from => :attachment
protected :attachment_details
mutable_attribute :groups
protected :groups
populates_from(:create_network_interface) do |resp|
resp.network_interface if resp.network_interface.network_interface_id == id
end
populates_from(:describe_network_interfaces) do |resp|
resp.network_interface_set.find{|i| i.network_interface_id == id }
end
# @return [VPC] Returns the VPC this network interface belongs to.
def vpc
VPC.new(vpc_id, :config => config)
end
# @return [Subnet] Returns the Subnet this network interface
# belongs to.
def subnet
Subnet.new(subnet_id, :vpc_id => vpc_id, :config => config)
end
# @return [ElasticIp,nil]
def elastic_ip
if association = self.association
opts = association.merge(:config => config)
ElasticIp.new(association[:public_ip], opts)
end
end
# @return [AvailabilityZone]
def availability_zone
AvailabilityZone.new(availability_zone_name, :config => config)
end
# @return [Array<SecurityGroup>]
def security_groups
groups.collect do |g|
SecurityGroup.new(g.group_id, :name => g.group_name, :config => config)
end
end
# @param [Array<SecurityGroup>,Array<String>] groups A list of
# security groups objects or security group ids. This replaces
# the security group set on this network interface.
#
# @return [nil]
#
def set_security_groups *groups
self.groups = [groups].flatten.collect do |g|
g.is_a?(SecurityGroup) ? g.security_group_id : g
end
nil
end
alias_method :security_groups=, :set_security_groups
# @return [Instance,nil] Returns the instance this network interface
# is attached to. If it has not been attached, then nil is
# returned.
def instance
if attachment = self.attachment
attachment.instance
end
end
# @return [Attachment,nil]
def attachment
if details = attachment_details
Attachment.new(self, details)
end
end
# @param [Instance,String] instance The instance to attach this network
# interface to, may be an {Instance} object or an instance id string.
#
# @param [Hash] options
#
# @option options [Integer] :device_index (1) The index of the device
# for the network interface attachment on the instance. Defaults to 1.
#
# @return [nil]
#
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
# Detaches this network interface.
# @param [Hash] options
# @option (see NetworkInterface::Attachment#detach)
# @return (see NetworkInterface::Attachment#detach)
def detach options = {}
if attachment = self.attachment
attachment.detach(options)
else
raise 'unable to detach network interface, no attachment present'
end
end
# Deletes this network interface.
# @return [nil]
def delete
client_opts = {}
client_opts[:network_interface_id] = network_interface_id
client.delete_network_interface(client_opts)
nil
end
# @return [Boolean] Returns true if this network interface exists.
def exists?
begin
get_resource
true
rescue Errors::InvalidNetworkInterfaceID::NotFound
false
end
end
end
end
end