NetworkInterface - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

NetworkInterface

Describes a network interface.

Contents

association

The association information for an Elastic IP address (IPv4) associated with the network interface.

Type: NetworkInterfaceAssociation object

Required: No

attachment

The network interface attachment.

Type: NetworkInterfaceAttachment object

Required: No

availabilityZone

The Availability Zone.

Type: String

Required: No

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.

Type: ConnectionTrackingConfiguration object

Required: No

denyAllIgwTraffic

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.

Type: Boolean

Required: No

description

A description.

Type: String

Required: No

groupSet

Any security groups for the network interface.

Type: Array of GroupIdentifier objects

Required: No

interfaceType

The type of network interface.

Type: String

Valid Values: api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint

Required: No

ipv4PrefixSet

The IPv4 prefixes that are assigned to the network interface.

Type: Array of Ipv4PrefixSpecification objects

Required: No

ipv6Address

The IPv6 globally unique address associated with the network interface.

Type: String

Required: No

ipv6AddressesSet

The IPv6 addresses associated with the network interface.

Type: Array of NetworkInterfaceIpv6Address objects

Required: No

ipv6Native

Indicates whether this is an IPv6 only network interface.

Type: Boolean

Required: No

ipv6PrefixSet

The IPv6 prefixes that are assigned to the network interface.

Type: Array of Ipv6PrefixSpecification objects

Required: No

macAddress

The MAC address.

Type: String

Required: No

networkInterfaceId

The ID of the network interface.

Type: String

Required: No

outpostArn

The Amazon Resource Name (ARN) of the Outpost.

Type: String

Required: No

ownerId

The Amazon Web Services account ID of the owner of the network interface.

Type: String

Required: No

privateDnsName

The private DNS name.

Type: String

Required: No

privateIpAddress

The IPv4 address of the network interface within the subnet.

Type: String

Required: No

privateIpAddressesSet

The private IPv4 addresses associated with the network interface.

Type: Array of NetworkInterfacePrivateIpAddress objects

Required: No

requesterId

The alias or Amazon Web Services account ID of the principal or service that created the network interface.

Type: String

Required: No

requesterManaged

Indicates whether the network interface is being managed by Amazon.

Type: Boolean

Required: No

sourceDestCheck

Indicates whether source/destination checking is enabled.

Type: Boolean

Required: No

status

The status of the network interface.

Type: String

Valid Values: available | associated | attaching | in-use | detaching

Required: No

subnetId

The ID of the subnet.

Type: String

Required: No

tagSet

Any tags assigned to the network interface.

Type: Array of Tag objects

Required: No

vpcId

The ID of the VPC.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: