Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

InstanceNetworkInterfaceSpecification

Describes a network interface.

Contents

AssociatePublicIpAddress (request), associatePublicIpAddress (response)

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

Type: Boolean

Required: No

DeleteOnTermination (request), deleteOnTermination (response)

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Type: Boolean

Required: No

Description (request), description (response)

The description of the network interface. Applies only if creating a network interface when launching an instance.

Type: String

Required: No

DeviceIndex (request), deviceIndex (response)

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

Type: Integer

Required: No

InterfaceType (request), InterfaceType (response)

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

Type: String

Required: No

Ipv6AddressCount (request), ipv6AddressCount (response)

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

Type: Integer

Required: No

Ipv6Addresses (request), ipv6AddressesSet (response)

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

Type: Array of InstanceIpv6Address objects

Required: No

NetworkInterfaceId (request), networkInterfaceId (response)

The ID of the network interface.

Type: String

Required: No

PrivateIpAddress (request), privateIpAddress (response)

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Type: String

Required: No

PrivateIpAddresses (request), privateIpAddressesSet (response)

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Type: Array of PrivateIpAddressSpecification objects

Required: No

SecondaryPrivateIpAddressCount (request), secondaryPrivateIpAddressCount (response)

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

Type: Integer

Required: No

Groups (request), SecurityGroupId (response)

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

Type: Array of strings

Required: No

SubnetId (request), subnetId (response)

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

Type: String

Required: No

See Also

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

On this page: