[ aws . ec2 ]

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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>]
[--ipv4-prefixes <value>]
[--ipv4-prefix-count <value>]
[--ipv6-prefixes <value>]
[--ipv6-prefix-count <value>]
[--interface-type <value>]
--subnet-id <value>
[--tag-specifications <value>]
[--client-token <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 .

--ipv4-prefixes (list)

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

(structure)

Describes the IPv4 prefix option for a network interface.

Ipv4Prefix -> (string)

The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

Shorthand Syntax:

Ipv4Prefix=string ...

JSON Syntax:

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

--ipv4-prefix-count (integer)

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

--ipv6-prefixes (list)

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

(structure)

Describes the IPv4 prefix option for a network interface.

Ipv6Prefix -> (string)

The IPv6 prefix.

Shorthand Syntax:

Ipv6Prefix=string ...

JSON Syntax:

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

--ipv6-prefix-count (integer)

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

--interface-type (string)

The type of network interface. The default is interface .

The only supported values are efa and trunk .

Possible values:

• efa

• branch

• trunk

--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.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

ResourceType -> (string)

The type of resource to tag on creation.

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 256 Unicode characters.

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-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"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-service"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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 Amazon Web Services 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 Amazon Web Services 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.

Ipv4Prefixes -> (list)

The IPv4 prefixes that are assigned to the network interface.

(structure)

Describes an IPv4 prefix.

Ipv4Prefix -> (string)

The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

Ipv6Prefixes -> (list)

The IPv6 prefixes that are assigned to the network interface.

(structure)

Describes the IPv6 prefix.

Ipv6Prefix -> (string)

The IPv6 prefix.

RequesterId -> (string)

The alias or Amazon Web Services account ID of the principal or service that created the network interface.

RequesterManaged -> (boolean)

Indicates whether the network interface is being managed by Amazon Web Services.

SourceDestCheck -> (boolean)

Indicates whether source/destination checking is enabled.

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 256 Unicode characters.

VpcId -> (string)

The ID of the VPC.

DenyAllIgwTraffic -> (boolean)

Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true , inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.

Ipv6Native -> (boolean)

Indicates whether this is an IPv6 only network interface.

Ipv6Address -> (string)

The IPv6 globally unique address associated with the network interface.

ClientToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.