AWS::EC2::NetworkInterfaceAttachment - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
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 (PDF).

AWS::EC2::NetworkInterfaceAttachment

Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::NetworkInterfaceAttachment",
  "Properties" : {
      "DeleteOnTermination" : Boolean,
      "DeviceIndex" : String,
      "InstanceId" : String,
      "NetworkInterfaceId" : String
    }
}

YAML

Type: AWS::EC2::NetworkInterfaceAttachment
Properties: 
  DeleteOnTermination: Boolean
  DeviceIndex: String
  InstanceId: String
  NetworkInterfaceId: String

Properties

DeleteOnTermination

Whether to delete the network interface when the instance terminates. By default, this value is set to true.

Required: No

Type: Boolean

Update requires: No interruption

DeviceIndex

The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.

Required: Yes

Type: String

Update requires: No interruption

InstanceId

The ID of the instance to which you will attach the ENI.

Required: Yes

Type: String

Update requires: No interruption

NetworkInterfaceId

The ID of the ENI that you want to attach.

Required: Yes

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the resource name.

For more information about using the Reffunction, see Ref.

Examples

Network interface attachment

The following example attaches MyNetworkInterface to MyInstance.

JSON

"NetworkInterfaceAttachment" : {
   "Type" : "AWS::EC2::NetworkInterfaceAttachment",
      "Properties" : {
         "InstanceId" : {"Ref" : "MyInstance"},
         "NetworkInterfaceId" : {"Ref" : "MyNetworkInterface"},
         "DeviceIndex" : "1" 
      }
}

YAML

NetworkInterfaceAttachment:
   Type: AWS::EC2::NetworkInterfaceAttachment
   Properties:
      InstanceId:
         Ref: MyInstance
      NetworkInterfaceId:
         Ref: MyNetworkInterface
      DeviceIndex: 1