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 AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::NetworkInterfaceAttachment", "Properties" : { "DeleteOnTermination" :
Boolean
, "DeviceIndex" :String
, "EnaSrdSpecification" :EnaSrdSpecification
, "InstanceId" :String
, "NetworkInterfaceId" :String
} }
YAML
Type: AWS::EC2::NetworkInterfaceAttachment Properties: DeleteOnTermination:
Boolean
DeviceIndex:String
EnaSrdSpecification:EnaSrdSpecification
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: Replacement
EnaSrdSpecification
-
Configures ENA Express for the network interface that this action attaches to the instance.
Required: No
Type: EnaSrdSpecification
Update requires: No interruption
InstanceId
-
The ID of the instance to which you will attach the ENI.
Required: Yes
Type: String
Update requires: Replacement
NetworkInterfaceId
-
The ID of the ENI that you want to attach.
Required: Yes
Type: String
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
AttachmentId
-
The ID of the network interface attachment.
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