Class: Aws::EC2::NetworkInterface
- Inherits:
-
Object
- Object
- Aws::EC2::NetworkInterface
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/network_interface.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#attachment ⇒ Types::NetworkInterfaceAttachment
The network interface attachment.
-
#availability_zone ⇒ String
The Availability Zone.
-
#connection_tracking_configuration ⇒ Types::ConnectionTrackingConfiguration
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface.
-
#deny_all_igw_traffic ⇒ Boolean
Indicates whether a network interface with an IPv6 address is unreachable from the public internet.
-
#description ⇒ String
A description.
-
#groups ⇒ Array<Types::GroupIdentifier>
Any security groups for the network interface.
- #id ⇒ String (also: #network_interface_id)
-
#interface_type ⇒ String
The type of network interface.
-
#ipv_4_prefixes ⇒ Array<Types::Ipv4PrefixSpecification>
The IPv4 prefixes that are assigned to the network interface.
-
#ipv_6_address ⇒ String
The IPv6 globally unique address associated with the network interface.
-
#ipv_6_addresses ⇒ Array<Types::NetworkInterfaceIpv6Address>
The IPv6 addresses associated with the network interface.
-
#ipv_6_native ⇒ Boolean
Indicates whether this is an IPv6 only network interface.
-
#ipv_6_prefixes ⇒ Array<Types::Ipv6PrefixSpecification>
The IPv6 prefixes that are assigned to the network interface.
-
#mac_address ⇒ String
The MAC address.
-
#outpost_arn ⇒ String
The Amazon Resource Name (ARN) of the Outpost.
-
#owner_id ⇒ String
The Amazon Web Services account ID of the owner of the network interface.
-
#private_dns_name ⇒ String
The private DNS name.
-
#private_ip_address ⇒ String
The IPv4 address of the network interface within the subnet.
-
#private_ip_addresses ⇒ Array<Types::NetworkInterfacePrivateIpAddress>
The private IPv4 addresses associated with the network interface.
-
#requester_id ⇒ String
The alias or Amazon Web Services account ID of the principal or service that created the network interface.
-
#requester_managed ⇒ Boolean
Indicates whether the network interface is being managed by Amazon Web Services.
-
#source_dest_check ⇒ Boolean
Indicates whether source/destination checking is enabled.
-
#status ⇒ String
The status of the network interface.
-
#subnet_id ⇒ String
The ID of the subnet.
-
#tag_set ⇒ Array<Types::Tag>
Any tags assigned to the network interface.
-
#vpc_id ⇒ String
The ID of the VPC.
Actions collapse
- #assign_private_ip_addresses(options = {}) ⇒ Types::AssignPrivateIpAddressesResult
- #attach(options = {}) ⇒ Types::AttachNetworkInterfaceResult
- #create_tags(options = {}) ⇒ Tag::Collection
- #delete(options = {}) ⇒ EmptyStructure
- #delete_tags(options = {}) ⇒ Tag::Collection
- #describe_attribute(options = {}) ⇒ Types::DescribeNetworkInterfaceAttributeResult
- #detach(options = {}) ⇒ EmptyStructure
- #modify_attribute(options = {}) ⇒ EmptyStructure
- #reset_attribute(options = {}) ⇒ EmptyStructure
- #unassign_private_ip_addresses(options = {}) ⇒ EmptyStructure
Associations collapse
- #association ⇒ NetworkInterfaceAssociation?
- #identifiers ⇒ Object deprecated private Deprecated.
- #subnet ⇒ Subnet?
- #vpc ⇒ Vpc?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::NetworkInterface
Returns the data for this NetworkInterface.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ NetworkInterface
constructor
A new instance of NetworkInterface.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current NetworkInterface.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ NetworkInterface #initialize(options = {}) ⇒ NetworkInterface
Returns a new instance of NetworkInterface.
22 23 24 25 26 27 28 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#assign_private_ip_addresses(options = {}) ⇒ Types::AssignPrivateIpAddressesResult
375 376 377 378 379 380 381 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 375 def assign_private_ip_addresses( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.assign_private_ip_addresses() end resp.data end |
#association ⇒ NetworkInterfaceAssociation?
723 724 725 726 727 728 729 730 731 732 733 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 723 def association if data[:association][:association_id] NetworkInterfaceAssociation.new( id: data[:association][:association_id], data: data[:association], client: @client ) else nil end end |
#attach(options = {}) ⇒ Types::AttachNetworkInterfaceResult
415 416 417 418 419 420 421 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 415 def attach( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.attach_network_interface() end resp.data end |
#attachment ⇒ Types::NetworkInterfaceAttachment
The network interface attachment.
40 41 42 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 40 def data[:attachment] end |
#availability_zone ⇒ String
The Availability Zone.
46 47 48 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 46 def availability_zone data[:availability_zone] end |
#client ⇒ Client
207 208 209 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 207 def client @client end |
#connection_tracking_configuration ⇒ Types::ConnectionTrackingConfiguration
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts] in the *Amazon Elastic Compute Cloud User Guide*.
59 60 61 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 59 def connection_tracking_configuration data[:connection_tracking_configuration] end |
#create_tags(options = {}) ⇒ Tag::Collection
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 445 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = Aws::Plugins::UserAgent.feature('resource') do @client.() end [:tags].each do |t| batch << Tag.new( resource_id: @id, key: t[:key], value: t[:value], client: @client ) end Tag::Collection.new([batch], size: batch.size) end |
#data ⇒ Types::NetworkInterface
Returns the data for this Aws::EC2::NetworkInterface. Calls Client#describe_network_interfaces if #data_loaded? is ‘false`.
229 230 231 232 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 229 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
237 238 239 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 237 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
521 522 523 524 525 526 527 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 521 def delete( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.delete_network_interface() end resp.data end |
#delete_tags(options = {}) ⇒ Tag::Collection
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 492 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = Aws::Plugins::UserAgent.feature('resource') do @client.() end [:tags].each do |t| batch << Tag.new( resource_id: @id, key: t[:key], value: t[:value], client: @client ) end Tag::Collection.new([batch], size: batch.size) end |
#deny_all_igw_traffic ⇒ Boolean
Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is ‘true`, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
187 188 189 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 187 def deny_all_igw_traffic data[:deny_all_igw_traffic] end |
#describe_attribute(options = {}) ⇒ Types::DescribeNetworkInterfaceAttributeResult
544 545 546 547 548 549 550 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 544 def describe_attribute( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_network_interface_attribute() end resp.data end |
#description ⇒ String
A description.
65 66 67 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 65 def description data[:description] end |
#detach(options = {}) ⇒ EmptyStructure
587 588 589 590 591 592 593 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 587 def detach( = {}) = .merge(attachment_id: data[:attachment][:attachment_id]) resp = Aws::Plugins::UserAgent.feature('resource') do @client.detach_network_interface() end resp.data end |
#groups ⇒ Array<Types::GroupIdentifier>
Any security groups for the network interface.
71 72 73 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 71 def groups data[:groups] end |
#id ⇒ String Also known as: network_interface_id
33 34 35 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 33 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.
761 762 763 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 761 def identifiers { id: @id } end |
#interface_type ⇒ String
The type of network interface.
77 78 79 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 77 def interface_type data[:interface_type] end |
#ipv_4_prefixes ⇒ Array<Types::Ipv4PrefixSpecification>
The IPv4 prefixes that are assigned to the network interface.
126 127 128 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 126 def ipv_4_prefixes data[:ipv_4_prefixes] end |
#ipv_6_address ⇒ String
The IPv6 globally unique address associated with the network interface.
200 201 202 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 200 def ipv_6_address data[:ipv_6_address] end |
#ipv_6_addresses ⇒ Array<Types::NetworkInterfaceIpv6Address>
The IPv6 addresses associated with the network interface.
83 84 85 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 83 def ipv_6_addresses data[:ipv_6_addresses] end |
#ipv_6_native ⇒ Boolean
Indicates whether this is an IPv6 only network interface.
193 194 195 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 193 def ipv_6_native data[:ipv_6_native] end |
#ipv_6_prefixes ⇒ Array<Types::Ipv6PrefixSpecification>
The IPv6 prefixes that are assigned to the network interface.
132 133 134 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 132 def ipv_6_prefixes data[:ipv_6_prefixes] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::NetworkInterface. Returns ‘self` making it possible to chain methods.
network_interface.reload.data
217 218 219 220 221 222 223 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 217 def load resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_network_interfaces(network_interface_ids: [@id]) end @data = resp.network_interfaces[0] self end |
#mac_address ⇒ String
The MAC address.
89 90 91 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 89 def mac_address data[:mac_address] end |
#modify_attribute(options = {}) ⇒ EmptyStructure
667 668 669 670 671 672 673 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 667 def modify_attribute( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.modify_network_interface_attribute() end resp.data end |
#outpost_arn ⇒ String
The Amazon Resource Name (ARN) of the Outpost.
95 96 97 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 95 def outpost_arn data[:outpost_arn] end |
#owner_id ⇒ String
The Amazon Web Services account ID of the owner of the network interface.
102 103 104 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 102 def owner_id data[:owner_id] end |
#private_dns_name ⇒ String
The private DNS name.
108 109 110 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 108 def private_dns_name data[:private_dns_name] end |
#private_ip_address ⇒ String
The IPv4 address of the network interface within the subnet.
114 115 116 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 114 def private_ip_address data[:private_ip_address] end |
#private_ip_addresses ⇒ Array<Types::NetworkInterfacePrivateIpAddress>
The private IPv4 addresses associated with the network interface.
120 121 122 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 120 def private_ip_addresses data[:private_ip_addresses] end |
#requester_id ⇒ String
The alias or Amazon Web Services account ID of the principal or service that created the network interface.
139 140 141 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 139 def requester_id data[:requester_id] end |
#requester_managed ⇒ Boolean
Indicates whether the network interface is being managed by Amazon Web Services.
146 147 148 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 146 def requester_managed data[:requester_managed] end |
#reset_attribute(options = {}) ⇒ EmptyStructure
690 691 692 693 694 695 696 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 690 def reset_attribute( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.reset_network_interface_attribute() end resp.data end |
#source_dest_check ⇒ Boolean
Indicates whether source/destination checking is enabled.
152 153 154 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 152 def source_dest_check data[:source_dest_check] end |
#status ⇒ String
The status of the network interface.
158 159 160 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 158 def status data[:status] end |
#subnet ⇒ Subnet?
736 737 738 739 740 741 742 743 744 745 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 736 def subnet if data[:subnet_id] Subnet.new( id: data[:subnet_id], client: @client ) else nil end end |
#subnet_id ⇒ String
The ID of the subnet.
164 165 166 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 164 def subnet_id data[:subnet_id] end |
#tag_set ⇒ Array<Types::Tag>
Any tags assigned to the network interface.
170 171 172 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 170 def tag_set data[:tag_set] end |
#unassign_private_ip_addresses(options = {}) ⇒ EmptyStructure
712 713 714 715 716 717 718 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 712 def unassign_private_ip_addresses( = {}) = .merge(network_interface_id: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.unassign_private_ip_addresses() end resp.data end |
#vpc ⇒ Vpc?
748 749 750 751 752 753 754 755 756 757 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 748 def vpc if data[:vpc_id] Vpc.new( id: data[:vpc_id], client: @client ) else nil end end |
#vpc_id ⇒ String
The ID of the VPC.
176 177 178 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 176 def vpc_id data[:vpc_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::EC2::Client] #wait_until instead
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() {|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
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/aws-sdk-ec2/network_interface.rb', line 321 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Plugins::UserAgent.feature('resource') do Aws::Waiters::Waiter.new().wait({}) end end |