InstanceNetworkInterfaceSpecification - 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.

InstanceNetworkInterfaceSpecification

Describes a network interface.

Contents

AssociateCarrierIpAddress (request), AssociateCarrierIpAddress (response)

Indicates whether to assign a carrier IP address to the network interface.

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Wavelength Developer Guide.

Type: Boolean

Required: No

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.

Valid values: interface | efa

Type: String

Required: No

Ipv4Prefixes (request), Ipv4Prefix (response)

One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

Type: Array of Ipv4PrefixSpecificationRequest objects

Required: No

Ipv4PrefixCount (request), Ipv4PrefixCount (response)

The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

Type: Integer

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

Ipv6Prefixes (request), Ipv6Prefix (response)

One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

Type: Array of Ipv6PrefixSpecificationRequest objects

Required: No

Ipv6PrefixCount (request), Ipv6PrefixCount (response)

The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

Type: Integer

Required: No

NetworkCardIndex (request), NetworkCardIndex (response)

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.

Type: Integer

Required: No

NetworkInterfaceId (request), networkInterfaceId (response)

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

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 Amazon SDKs, see the following: