AWS::EC2::LaunchTemplate NetworkInterface
Specifies the parameters for a network interface.
NetworkInterface
is a property of AWS::EC2::LaunchTemplate LaunchTemplateData.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AssociateCarrierIpAddress" :
Boolean
, "AssociatePublicIpAddress" :Boolean
, "DeleteOnTermination" :Boolean
, "Description" :String
, "DeviceIndex" :Integer
, "Groups" :[ String, ... ]
, "InterfaceType" :String
, "Ipv4PrefixCount" :Integer
, "Ipv4Prefixes" :[ Ipv4PrefixSpecification, ... ]
, "Ipv6AddressCount" :Integer
, "Ipv6Addresses" :[ Ipv6Add, ... ]
, "Ipv6PrefixCount" :Integer
, "Ipv6Prefixes" :[ Ipv6PrefixSpecification, ... ]
, "NetworkCardIndex" :Integer
, "NetworkInterfaceId" :String
, "PrivateIpAddress" :String
, "PrivateIpAddresses" :[ PrivateIpAdd, ... ]
, "SecondaryPrivateIpAddressCount" :Integer
, "SubnetId" :String
}
YAML
AssociateCarrierIpAddress:
Boolean
AssociatePublicIpAddress:Boolean
DeleteOnTermination:Boolean
Description:String
DeviceIndex:Integer
Groups:- String
InterfaceType:String
Ipv4PrefixCount:Integer
Ipv4Prefixes:- Ipv4PrefixSpecification
Ipv6AddressCount:Integer
Ipv6Addresses:- Ipv6Add
Ipv6PrefixCount:Integer
Ipv6Prefixes:- Ipv6PrefixSpecification
NetworkCardIndex:Integer
NetworkInterfaceId:String
PrivateIpAddress:String
PrivateIpAddresses:- PrivateIpAdd
SecondaryPrivateIpAddressCount:Integer
SubnetId:String
Properties
AssociateCarrierIpAddress
-
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.
Required: No
Type: Boolean
Update requires: No interruption
AssociatePublicIpAddress
-
Associates a public IPv4 address with eth0 for a new network interface.
Required: No
Type: Boolean
Update requires: No interruption
DeleteOnTermination
-
Indicates whether the network interface is deleted when the instance is terminated.
Required: No
Type: Boolean
Update requires: No interruption
Description
-
A description for the network interface.
Required: No
Type: String
Update requires: No interruption
DeviceIndex
-
The device index for the network interface attachment.
Required: No
Type: Integer
Update requires: No interruption
Groups
-
The IDs of one or more security groups.
Required: No
Type: List of String
Update requires: No interruption
InterfaceType
-
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
Required: No
Type: String
Update requires: No interruption
Ipv4PrefixCount
-
The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv4Prefix
option.Required: No
Type: Integer
Update requires: No interruption
Ipv4Prefixes
-
One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv4PrefixCount
option.Required: No
Type: List of Ipv4PrefixSpecification
Update requires: No interruption
Ipv6AddressCount
-
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
Required: No
Type: Integer
Update requires: No interruption
Ipv6Addresses
-
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
Required: No
Type: List of Ipv6Add
Update requires: No interruption
Ipv6PrefixCount
-
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the
Ipv6Prefix
option.Required: No
Type: Integer
Update requires: No interruption
Ipv6Prefixes
-
One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv6PrefixCount
option.Required: No
Type: List of Ipv6PrefixSpecification
Update requires: No interruption
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.
Required: No
Type: Integer
Update requires: No interruption
NetworkInterfaceId
-
The ID of the network interface.
Required: No
Type: String
Update requires: No interruption
PrivateIpAddress
-
The primary private IPv4 address of the network interface.
Required: No
Type: String
Update requires: No interruption
PrivateIpAddresses
-
One or more private IPv4 addresses.
Required: No
Type: List of PrivateIpAdd
Update requires: No interruption
SecondaryPrivateIpAddressCount
-
The number of secondary private IPv4 addresses to assign to a network interface.
Required: No
Type: Integer
Update requires: No interruption
SubnetId
-
The ID of the subnet for the network interface.
Required: No
Type: String
Update requires: No interruption
See also
-
LaunchTemplateInstanceNetworkInterfaceSpecificationRequest in the Amazon EC2 API Reference