Skip to content

Create Network Interface

ec2_create_network_interface R Documentation

Creates a network interface in the specified subnet

Description

Creates a network interface in the specified subnet.

The number of IP addresses you can assign to a network interface varies by instance type.

For more information about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.

Usage

ec2_create_network_interface(Description, DryRun, Groups,
  Ipv6AddressCount, Ipv6Addresses, PrivateIpAddress, PrivateIpAddresses,
  SecondaryPrivateIpAddressCount, Ipv4Prefixes, Ipv4PrefixCount,
  Ipv6Prefixes, Ipv6PrefixCount, InterfaceType, SubnetId,
  TagSpecifications, ClientToken, EnablePrimaryIpv6,
  ConnectionTrackingSpecification)

Arguments

Description

A description for the network interface.

DryRun

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

The IDs of one or more security groups.

Ipv6AddressCount

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 specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.

Ipv6Addresses

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

PrivateIpAddress

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

PrivateIpAddresses

The private IPv4 addresses.

You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

SecondaryPrivateIpAddressCount

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.

You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

Ipv4Prefixes

The IPv4 prefixes assigned to the network interface.

You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

Ipv4PrefixCount

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

Ipv6Prefixes

The IPv6 prefixes assigned to the network interface.

You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

Ipv6PrefixCount

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

InterfaceType

The type of network interface. The default is interface.

The only supported values are interface, efa, and trunk.

SubnetId

[required] The ID of the subnet to associate with the network interface.

TagSpecifications

The tags to apply to the new network interface.

ClientToken

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

EnablePrimaryIpv6

If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

ConnectionTrackingSpecification

A connection tracking specification for the network interface.

Value

A list with the following syntax: 

list(
  NetworkInterface = list(
    Association = list(
      AllocationId = "string",
      AssociationId = "string",
      IpOwnerId = "string",
      PublicDnsName = "string",
      PublicIp = "string",
      CustomerOwnedIp = "string",
      CarrierIp = "string"
    ),
    Attachment = list(
      AttachTime = as.POSIXct(
        "2015-01-01"
      ),
      AttachmentId = "string",
      DeleteOnTermination = TRUE|FALSE,
      DeviceIndex = 123,
      NetworkCardIndex = 123,
      InstanceId = "string",
      InstanceOwnerId = "string",
      Status = "attaching"|"attached"|"detaching"|"detached",
      EnaSrdSpecification = list(
        EnaSrdEnabled = TRUE|FALSE,
        EnaSrdUdpSpecification = list(
          EnaSrdUdpEnabled = TRUE|FALSE
        )
      )
    ),
    AvailabilityZone = "string",
    ConnectionTrackingConfiguration = list(
      TcpEstablishedTimeout = 123,
      UdpStreamTimeout = 123,
      UdpTimeout = 123
    ),
    Description = "string",
    Groups = list(
      list(
        GroupName = "string",
        GroupId = "string"
      )
    ),
    InterfaceType = "interface"|"natGateway"|"efa"|"trunk"|"load_balancer"|"network_load_balancer"|"vpc_endpoint"|"branch"|"transit_gateway"|"lambda"|"quicksight"|"global_accelerator_managed"|"api_gateway_managed"|"gateway_load_balancer"|"gateway_load_balancer_endpoint"|"iot_rules_managed"|"aws_codestar_connections_managed",
    Ipv6Addresses = list(
      list(
        Ipv6Address = "string",
        IsPrimaryIpv6 = TRUE|FALSE
      )
    ),
    MacAddress = "string",
    NetworkInterfaceId = "string",
    OutpostArn = "string",
    OwnerId = "string",
    PrivateDnsName = "string",
    PrivateIpAddress = "string",
    PrivateIpAddresses = list(
      list(
        Association = list(
          AllocationId = "string",
          AssociationId = "string",
          IpOwnerId = "string",
          PublicDnsName = "string",
          PublicIp = "string",
          CustomerOwnedIp = "string",
          CarrierIp = "string"
        ),
        Primary = TRUE|FALSE,
        PrivateDnsName = "string",
        PrivateIpAddress = "string"
      )
    ),
    Ipv4Prefixes = list(
      list(
        Ipv4Prefix = "string"
      )
    ),
    Ipv6Prefixes = list(
      list(
        Ipv6Prefix = "string"
      )
    ),
    RequesterId = "string",
    RequesterManaged = TRUE|FALSE,
    SourceDestCheck = TRUE|FALSE,
    Status = "available"|"associated"|"attaching"|"in-use"|"detaching",
    SubnetId = "string",
    TagSet = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    VpcId = "string",
    DenyAllIgwTraffic = TRUE|FALSE,
    Ipv6Native = TRUE|FALSE,
    Ipv6Address = "string"
  ),
  ClientToken = "string"
)

Request syntax

svc$create_network_interface(
  Description = "string",
  DryRun = TRUE|FALSE,
  Groups = list(
    "string"
  ),
  Ipv6AddressCount = 123,
  Ipv6Addresses = list(
    list(
      Ipv6Address = "string",
      IsPrimaryIpv6 = TRUE|FALSE
    )
  ),
  PrivateIpAddress = "string",
  PrivateIpAddresses = list(
    list(
      Primary = TRUE|FALSE,
      PrivateIpAddress = "string"
    )
  ),
  SecondaryPrivateIpAddressCount = 123,
  Ipv4Prefixes = list(
    list(
      Ipv4Prefix = "string"
    )
  ),
  Ipv4PrefixCount = 123,
  Ipv6Prefixes = list(
    list(
      Ipv6Prefix = "string"
    )
  ),
  Ipv6PrefixCount = 123,
  InterfaceType = "efa"|"branch"|"trunk",
  SubnetId = "string",
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"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-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"ipam-external-resource-verification-token",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  ClientToken = "string",
  EnablePrimaryIpv6 = TRUE|FALSE,
  ConnectionTrackingSpecification = list(
    TcpEstablishedTimeout = 123,
    UdpStreamTimeout = 123,
    UdpTimeout = 123
  )
)

Examples

## Not run: 
# This example creates a network interface for the specified subnet.
svc$create_network_interface(
  Description = "my network interface",
  Groups = list(
    "sg-903004f8"
  ),
  PrivateIpAddress = "10.0.2.17",
  SubnetId = "subnet-9d4a7b6c"
)

## End(Not run)