Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon EC2 Resource Types Reference » AWS::EC2::NetworkInterfaceAttachment

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 instances without interruption.

Syntax

To declare this entity in your AWS 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 the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Example

Attaching 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