Documentation

Describes a network interface.

See: newInstanceNetworkInterfaceSpecification smart constructor.

Create a value of InstanceNetworkInterfaceSpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:associateCarrierIpAddress:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_associateCarrierIpAddress - 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 address in the Amazon Web Services Wavelength Developer Guide.

$sel:associatePublicIpAddress:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_associatePublicIpAddress - 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.

$sel:deleteOnTermination:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_deleteOnTermination - 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.

$sel:description:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_description - The description of the network interface. Applies only if creating a network interface when launching an instance.

$sel:deviceIndex:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_deviceIndex - 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.

$sel:groups:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_groups - The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

$sel:interfaceType:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_interfaceType - The type of network interface.

Valid values: interface | efa

$sel:ipv4PrefixCount:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_ipv4PrefixCount - 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.

$sel:ipv4Prefixes:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_ipv4Prefixes - The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

$sel:ipv6AddressCount:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_ipv6AddressCount - 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.

$sel:ipv6Addresses:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_ipv6Addresses - The 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.

$sel:ipv6PrefixCount:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_ipv6PrefixCount - 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.

$sel:ipv6Prefixes:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_ipv6Prefixes - The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

$sel:networkCardIndex:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_networkCardIndex - 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.

$sel:networkInterfaceId:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_networkInterfaceId - 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.

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

$sel:privateIpAddresses:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_privateIpAddresses - The 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.

$sel:secondaryPrivateIpAddressCount:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_secondaryPrivateIpAddressCount - 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.

$sel:subnetId:InstanceNetworkInterfaceSpecification', instanceNetworkInterfaceSpecification_subnetId - The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

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 address in the Amazon Web Services Wavelength Developer Guide.

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.

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.

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

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.

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

The type of network interface.

Valid values: interface | efa

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.

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

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.

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

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.

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

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.

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.

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.

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

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.

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