EC2 / Client / create_network_interface

create_network_interface#

EC2.Client.create_network_interface(**kwargs)#

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, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

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

Request Syntax

response = client.create_network_interface(
    Description='string',
    DryRun=True|False,
    Groups=[
        'string',
    ],
    Ipv6AddressCount=123,
    Ipv6Addresses=[
        {
            'Ipv6Address': 'string'
        },
    ],
    PrivateIpAddress='string',
    PrivateIpAddresses=[
        {
            'Primary': True|False,
            'PrivateIpAddress': 'string'
        },
    ],
    SecondaryPrivateIpAddressCount=123,
    Ipv4Prefixes=[
        {
            'Ipv4Prefix': 'string'
        },
    ],
    Ipv4PrefixCount=123,
    Ipv6Prefixes=[
        {
            'Ipv6Prefix': 'string'
        },
    ],
    Ipv6PrefixCount=123,
    InterfaceType='efa'|'branch'|'trunk',
    SubnetId='string',
    TagSpecifications=[
        {
            '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',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string'
)

Parameters:

Description (string) – A description for the network interface.
DryRun (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) –
Ipv6AddressCount (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 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 (list) –
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.
- (dict) –
  
  Describes an IPv6 address.
  - Ipv6Address (string) –
    
    The IPv6 address.
PrivateIpAddress (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).
PrivateIpAddresses (list) –
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.
- (dict) –
  
  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 address.
SecondaryPrivateIpAddressCount (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.

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 (list) –
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.
- (dict) –
  
  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.
Ipv4PrefixCount (integer) –
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 (list) –
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.
- (dict) –
  
  Describes the IPv4 prefix option for a network interface.
  - Ipv6Prefix (string) –
    
    The IPv6 prefix.
Ipv6PrefixCount (integer) –
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 (string) –
The type of network interface. The default is interface.

The only supported values are efa and trunk.
SubnetId (string) –
[REQUIRED]

The ID of the subnet to associate with the network interface.
TagSpecifications (list) –
The tags to apply to the new network interface.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  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.
    - (dict) –
      
      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.
ClientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkInterface': {
        'Association': {
            'AllocationId': 'string',
            'AssociationId': 'string',
            'IpOwnerId': 'string',
            'PublicDnsName': 'string',
            'PublicIp': 'string',
            'CustomerOwnedIp': 'string',
            'CarrierIp': 'string'
        },
        'Attachment': {
            'AttachTime': datetime(2015, 1, 1),
            'AttachmentId': 'string',
            'DeleteOnTermination': True|False,
            'DeviceIndex': 123,
            'NetworkCardIndex': 123,
            'InstanceId': 'string',
            'InstanceOwnerId': 'string',
            'Status': 'attaching'|'attached'|'detaching'|'detached',
            'EnaSrdSpecification': {
                'EnaSrdEnabled': True|False,
                'EnaSrdUdpSpecification': {
                    'EnaSrdUdpEnabled': True|False
                }
            }
        },
        'AvailabilityZone': 'string',
        'Description': 'string',
        'Groups': [
            {
                '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': [
            {
                'Ipv6Address': 'string'
            },
        ],
        'MacAddress': 'string',
        'NetworkInterfaceId': 'string',
        'OutpostArn': 'string',
        'OwnerId': 'string',
        'PrivateDnsName': 'string',
        'PrivateIpAddress': 'string',
        'PrivateIpAddresses': [
            {
                'Association': {
                    'AllocationId': 'string',
                    'AssociationId': 'string',
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'CustomerOwnedIp': 'string',
                    'CarrierIp': 'string'
                },
                'Primary': True|False,
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string'
            },
        ],
        'Ipv4Prefixes': [
            {
                'Ipv4Prefix': 'string'
            },
        ],
        'Ipv6Prefixes': [
            {
                'Ipv6Prefix': 'string'
            },
        ],
        'RequesterId': 'string',
        'RequesterManaged': True|False,
        'SourceDestCheck': True|False,
        'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
        'SubnetId': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'VpcId': 'string',
        'DenyAllIgwTraffic': True|False,
        'Ipv6Native': True|False,
        'Ipv6Address': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

(dict) –
- NetworkInterface (dict) –
  
  Information about the network interface.
  - Association (dict) –
    
    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 (dict) –
    
    The network interface attachment.
    - AttachTime (datetime) –
      
      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.
    - EnaSrdSpecification (dict) –
      
      Configures ENA Express for the network interface that this action attaches to the instance.
      - EnaSrdEnabled (boolean) –
        
        Indicates whether ENA Express is enabled for the network interface that’s attached to the instance.
      - EnaSrdUdpSpecification (dict) –
        
        ENA Express configuration for UDP network traffic.
        
        EnaSrdUdpEnabled (boolean) –
        
        Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
  - AvailabilityZone (string) –
    
    The Availability Zone.
  - Description (string) –
    
    A description.
  - Groups (list) –
    
    Any security groups for the network interface.
    - (dict) –
      
      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.
    - (dict) –
      
      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.
    - (dict) –
      
      Describes the private IPv4 address of a network interface.
      - Association (dict) –
        
        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.
    - (dict) –
      
      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.
    - (dict) –
      
      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.
    - (dict) –
      
      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.

Examples

This example creates a network interface for the specified subnet.

response = client.create_network_interface(
    Description='my network interface',
    Groups=[
        'sg-903004f8',
    ],
    PrivateIpAddress='10.0.2.17',
    SubnetId='subnet-9d4a7b6c',
)

print(response)

Expected Output:

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