create-network-interface¶

Description¶

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide .

Synopsis¶

  create-network-interface
[--description <value>]
[--dry-run | --no-dry-run]
[--groups <value>]
[--ipv6-address-count <value>]
[--ipv6-addresses <value>]
[--private-ip-address <value>]
[--private-ip-addresses <value>]
[--secondary-private-ip-address-count <value>]
[--interface-type <value>]
--subnet-id <value>
[--tag-specifications <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--description (string)

A description for the network interface.

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--groups (list)

The IDs of one or more security groups.

(string)

Syntax:

"string" "string" ...

--ipv6-address-count (integer)

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can’t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true , you can specify 0 to override this setting.

--ipv6-addresses (list)

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.

(structure)

Describes an IPv6 address.

Ipv6Address -> (string)

The IPv6 address.

Shorthand Syntax:

Ipv6Address=string ...

JSON Syntax:

[
  {
    "Ipv6Address": "string"
  }
  ...
]

--private-ip-address (string)

The primary private IPv4 address of the network interface. If you don’t specify an IPv4 address, Amazon EC2 selects one for you from the subnet’s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

--private-ip-addresses (list)

One or more private IPv4 addresses.

(structure)

Describes a secondary private IPv4 address for a network interface.

Primary -> (boolean)

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

PrivateIpAddress -> (string)

The private IPv4 addresses.

Shorthand Syntax:

Primary=boolean,PrivateIpAddress=string ...

JSON Syntax:

[
  {
    "Primary": true|false,
    "PrivateIpAddress": "string"
  }
  ...
]

--secondary-private-ip-address-count (integer)

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet’s IPv4 CIDR range. You can’t specify this option and specify more than one private IP address using privateIpAddresses .

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .

--interface-type (string)

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .

Possible values:

efa

--subnet-id (string)

The ID of the subnet to associate with the network interface.

--tag-specifications (list)

The tags to apply to the new network interface.

(structure)

The tags to apply to a resource when the resource is being created.

ResourceType -> (string)

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .

To tag a resource after it has been created, see CreateTags .

Tags -> (list)

The tags to apply to the resource.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"internet-gateway"|"key-pair"|"launch-template"|"local-gateway-route-table-vpc-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"placement-group"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a network interface

This example creates a network interface for the specified subnet.

Command:

aws ec2 create-network-interface --subnet-id subnet-9d4a7b6c --description "my network interface" --groups sg-903004f8 --private-ip-address 10.0.2.17

Output:

{
    "NetworkInterface": {
        "Status": "pending",
        "MacAddress": "02:1a:80:41:52:9c",
        "SourceDestCheck": true,
        "VpcId": "vpc-a01106c2",
        "Description": "my network interface",
        "NetworkInterfaceId": "eni-e5aa89a3",
        "PrivateIpAddresses": [
            {
                "Primary": true,
                "PrivateIpAddress": "10.0.2.17"
            }
        ],
        "RequesterManaged": false,
        "AvailabilityZone": "us-east-1d",
        "Ipv6Addresses": [],
        "Groups": [
            {
                "GroupName": "default",
                "GroupId": "sg-903004f8"
            }
        ],
        "SubnetId": "subnet-9d4a7b6c",
        "OwnerId": "123456789012",
        "TagSet": [],
        "PrivateIpAddress": "10.0.2.17"
    }
}

Output¶

NetworkInterface -> (structure)

Information about the network interface.

Association -> (structure)

The association information for an Elastic IP address (IPv4) associated with the network interface.

AllocationId -> (string)

The allocation ID.

AssociationId -> (string)

The association ID.

IpOwnerId -> (string)

The ID of the Elastic IP address owner.

PublicDnsName -> (string)

The public DNS name.

PublicIp -> (string)

The address of the Elastic IP address bound to the network interface.

CustomerOwnedIp -> (string)

The customer-owned IP address associated with the network interface.

CarrierIp -> (string)

The carrier IP address associated with the network interface.

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

Attachment -> (structure)

The network interface attachment.

AttachTime -> (timestamp)

The timestamp indicating when the attachment initiated.

AttachmentId -> (string)

The ID of the network interface attachment.

DeleteOnTermination -> (boolean)

Indicates whether the network interface is deleted when the instance is terminated.

DeviceIndex -> (integer)

The device index of the network interface attachment on the instance.

NetworkCardIndex -> (integer)

The index of the network card.

InstanceId -> (string)

The ID of the instance.

InstanceOwnerId -> (string)

The AWS account ID of the owner of the instance.

Status -> (string)

The attachment state.

AvailabilityZone -> (string)

The Availability Zone.

Description -> (string)

A description.

Groups -> (list)

Any security groups for the network interface.

(structure)

Describes a security group.

GroupName -> (string)

The name of the security group.

GroupId -> (string)

The ID of the security group.

InterfaceType -> (string)

The type of network interface.

Ipv6Addresses -> (list)

The IPv6 addresses associated with the network interface.

(structure)

Describes an IPv6 address associated with a network interface.

Ipv6Address -> (string)

The IPv6 address.

MacAddress -> (string)

The MAC address.

NetworkInterfaceId -> (string)

The ID of the network interface.

OutpostArn -> (string)

The Amazon Resource Name (ARN) of the Outpost.

OwnerId -> (string)

The AWS account ID of the owner of the network interface.

PrivateDnsName -> (string)

The private DNS name.

PrivateIpAddress -> (string)

The IPv4 address of the network interface within the subnet.

PrivateIpAddresses -> (list)

The private IPv4 addresses associated with the network interface.

(structure)

Describes the private IPv4 address of a network interface.

Association -> (structure)

The association information for an Elastic IP address (IPv4) associated with the network interface.

AllocationId -> (string)

The allocation ID.

AssociationId -> (string)

The association ID.

IpOwnerId -> (string)

The ID of the Elastic IP address owner.

PublicDnsName -> (string)

The public DNS name.

PublicIp -> (string)

The address of the Elastic IP address bound to the network interface.

CustomerOwnedIp -> (string)

The customer-owned IP address associated with the network interface.

CarrierIp -> (string)

The carrier IP address associated with the network interface.

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

Primary -> (boolean)

Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

PrivateDnsName -> (string)

The private DNS name.

PrivateIpAddress -> (string)

The private IPv4 address.

RequesterId -> (string)

The alias or AWS account ID of the principal or service that created the network interface.

RequesterManaged -> (boolean)

Indicates whether the network interface is being managed by AWS.

SourceDestCheck -> (boolean)

Indicates whether traffic to or from the instance is validated.

Status -> (string)

The status of the network interface.

SubnetId -> (string)

The ID of the subnet.

TagSet -> (list)

Any tags assigned to the network interface.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

VpcId -> (string)

The ID of the VPC.

Table of Contents

Feedback

User Guide

create-network-interface¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶