create_network_interface¶
Operation¶
create_network_interface
async
¶
create_network_interface(input: CreateNetworkInterfaceInput, plugins: list[Plugin] | None = None) -> CreateNetworkInterfaceOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateNetworkInterfaceInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateNetworkInterfaceOutput
|
An instance of |
Input¶
CreateNetworkInterfaceInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateNetworkInterfaceInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
connection_tracking_specification
class-attribute
instance-attribute
¶
connection_tracking_specification: ConnectionTrackingSpecificationRequest | None = ...
A connection tracking specification for the network interface.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the network interface.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
enable_primary_ipv6
class-attribute
instance-attribute
¶
enable_primary_ipv6: bool | None = ...
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.
groups
class-attribute
instance-attribute
¶
The IDs of the security groups.
interface_type
class-attribute
instance-attribute
¶
interface_type: str | None = ...
The type of network interface. The default is interface.
If you specify efa-only, do not assign any IP addresses to the network
interface. EFA-only network interfaces do not support IP addresses.
The only supported values are interface, efa, efa-only, and
trunk.
ipv4_prefix_count
class-attribute
instance-attribute
¶
ipv4_prefix_count: int | None = ...
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.
ipv4_prefixes
class-attribute
instance-attribute
¶
ipv4_prefixes: list[Ipv4PrefixSpecificationRequest] | None = ...
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.
ipv6_address_count
class-attribute
instance-attribute
¶
ipv6_address_count: int | None = ...
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.
ipv6_addresses
class-attribute
instance-attribute
¶
ipv6_addresses: list[InstanceIpv6Address] | None = ...
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.
ipv6_prefix_count
class-attribute
instance-attribute
¶
ipv6_prefix_count: int | None = ...
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.
ipv6_prefixes
class-attribute
instance-attribute
¶
ipv6_prefixes: list[Ipv6PrefixSpecificationRequest] | None = ...
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.
operator
class-attribute
instance-attribute
¶
operator: OperatorRequest | None = ...
Reserved for internal use.
private_ip_address
class-attribute
instance-attribute
¶
private_ip_address: str | None = ...
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
class-attribute
instance-attribute
¶
private_ip_addresses: list[PrivateIpAddressSpecification] | None = ...
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.
secondary_private_ip_address_count
class-attribute
instance-attribute
¶
secondary_private_ip_address_count: int | None = ...
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.
subnet_id
class-attribute
instance-attribute
¶
subnet_id: str | None = ...
The ID of the subnet to associate with the network interface.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the new network interface.
Output¶
CreateNetworkInterfaceOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateNetworkInterfaceOutput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
network_interface
class-attribute
instance-attribute
¶
network_interface: NetworkInterface | None = ...
Information about the network interface.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.