The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::EC2::Instance NetworkInterface

Specifies a network interface that is to be attached to an instance.

NetworkInterface is a property of the AWS::EC2::Instance resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "AssociatePublicIpAddress" : Boolean,
  "DeleteOnTermination" : Boolean,
  "Description" : String,
  "DeviceIndex" : String,
  "GroupSet" : [ String, ... ],
  "Ipv6AddressCount" : Integer,
  "Ipv6Addresses" : [ InstanceIpv6Address, ... ],
  "NetworkInterfaceId" : String,
  "PrivateIpAddress" : String,
  "PrivateIpAddresses" : [ PrivateIpAddressSpecification, ... ],
  "SecondaryPrivateIpAddressCount" : Integer,
  "SubnetId" : String
}

YAML


  AssociatePublicIpAddress: Boolean
  DeleteOnTermination: Boolean
  Description: String
  DeviceIndex: String
  GroupSet: 
    - String
  Ipv6AddressCount: Integer
  Ipv6Addresses: 
    - InstanceIpv6Address
  NetworkInterfaceId: String
  PrivateIpAddress: String
  PrivateIpAddresses: 
    - PrivateIpAddressSpecification
  SecondaryPrivateIpAddressCount: Integer
  SubnetId: String

Properties

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.

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Description

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

Required: No

Type: String

Update requires: No interruption

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.

Required: Conditional

Type: String

Update requires: No interruption

GroupSet

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

Required: No

Type: List of String

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

Ipv6Addresses

The IPv6 addresses associated with the network interface.

Required: No

Type: List of InstanceIpv6Address

Update requires: No interruption

NetworkInterfaceId

The ID of the network interface.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

PrivateIpAddresses

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.

Required: No

Type: List of PrivateIpAddressSpecification

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

SubnetId