AWS::EC2::NetworkInterfacePermission - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::EC2::NetworkInterfacePermission

Specifies a permission for the network interface, For example, you can grant an AWS-authorized account permission to attach the network interface to an instance in their account.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::NetworkInterfacePermission",
  "Properties" : {
      "AwsAccountId" : String,
      "NetworkInterfaceId" : String,
      "Permission" : String
    }
}

YAML

Type: AWS::EC2::NetworkInterfacePermission
Properties:
  AwsAccountId: String
  NetworkInterfaceId: String
  Permission: String

Properties

AwsAccountId

The AWS account ID.

Required: Yes

Type: String

Update requires: Replacement

NetworkInterfaceId

The ID of the network interface.

Required: Yes

Type: String

Update requires: Replacement

Permission

The type of permission to grant: INSTANCE-ATTACH or EIP-ASSOCIATE.

Required: Yes

Type: String

Allowed values: INSTANCE-ATTACH | EIP-ASSOCIATE

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 example: eni-perm-055663b682ea24b48.

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

Examples

Grant INSTANCE-ATTACH permission

The following example creates a permission (INSTANCE-ATTACH) for a specified network interface and AWS account.

JSON

"MyNetworkInterfacePermission": {
   "Type": "AWS::EC2::NetworkInterfacePermission",
   "Properties": {
      "NetworkInterfaceId": "eni-030e3xxx",
      "AwsAccountId": "11111111111",
      "Permission": "INSTANCE-ATTACH"
   }
}

YAML

   MyNetworkInterfacePermission:
      Type: AWS::EC2::NetworkInterfacePermission
      Properties:
         NetworkInterfaceId: eni-030e3xxx
         AwsAccountId: '11111111111'
         Permission: INSTANCE-ATTACH