Skip to content

NetworkInterface

Source code in docs_src/capo_ec2/types/network_interface.py
class NetworkInterface(TypedDict, closed=True):
    association: NotRequired[
        "capo_ec2.types.network_interface_association.NetworkInterfaceAssociation"
    ]
    """<p>The association information for an Elastic IP address (IPv4) associated with the network interface.</p>"""
    attachment: NotRequired[
        "capo_ec2.types.network_interface_attachment.NetworkInterfaceAttachment"
    ]
    """<p>The network interface attachment.</p>"""
    availability_zone: NotRequired["capo_ec2.types.string.String"]
    """<p>The Availability Zone.</p>"""
    connection_tracking_configuration: NotRequired[
        "capo_ec2.types.connection_tracking_configuration.ConnectionTrackingConfiguration"
    ]
    """<p>A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts">Connection tracking timeouts</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>A description.</p>"""
    groups: NotRequired["capo_ec2.types.group_identifier_list.GroupIdentifierList"]
    """<p>Any security groups for the network interface.</p>"""
    interface_type: NotRequired[
        "capo_ec2.types.network_interface_type.NetworkInterfaceType"
    ]
    """<p>The type of network interface.</p>"""
    ipv6_addresses: NotRequired[
        "capo_ec2.types.network_interface_ipv6_addresses_list.NetworkInterfaceIpv6AddressesList"
    ]
    """<p>The IPv6 addresses associated with the network interface.</p>"""
    mac_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The MAC address.</p>"""
    network_interface_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the network interface.</p>"""
    outpost_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Outpost.</p>"""
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services account ID of the owner of the network interface.</p>"""
    private_dns_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The private hostname. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html">EC2 instance hostnames, DNS names, and domains</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    public_dns_name: NotRequired["capo_ec2.types.string.String"]
    """<p>A public hostname. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html">EC2 instance hostnames, DNS names, and domains</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    public_ip_dns_name_options: NotRequired[
        "capo_ec2.types.public_ip_dns_name_options.PublicIpDnsNameOptions"
    ]
    """<p>Public hostname type options. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html">EC2 instance hostnames, DNS names, and domains</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    private_ip_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv4 address of the network interface within the subnet.</p>"""
    private_ip_addresses: NotRequired[
        "capo_ec2.types.network_interface_private_ip_address_list.NetworkInterfacePrivateIpAddressList"
    ]
    """<p>The private IPv4 addresses associated with the network interface.</p>"""
    ipv4_prefixes: NotRequired["capo_ec2.types.ipv4_prefixes_list.Ipv4PrefixesList"]
    """<p>The IPv4 prefixes that are assigned to the network interface.</p>"""
    ipv6_prefixes: NotRequired["capo_ec2.types.ipv6_prefixes_list.Ipv6PrefixesList"]
    """<p>The IPv6 prefixes that are assigned to the network interface.</p>"""
    requester_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The alias or Amazon Web Services account ID of the principal or service that created the network interface.</p>"""
    requester_managed: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the network interface is being managed by Amazon Web Services.</p>"""
    source_dest_check: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether source/destination checking is enabled.</p>"""
    status: NotRequired[
        "capo_ec2.types.network_interface_status.NetworkInterfaceStatus"
    ]
    """<p>The status of the network interface.</p>"""
    subnet_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the subnet.</p>"""
    tag_set: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>Any tags assigned to the network interface.</p>"""
    vpc_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the VPC.</p>"""
    deny_all_igw_traffic: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is <code>true</code>, 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.</p>"""
    ipv6_native: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether this is an IPv6 only network interface.</p>"""
    ipv6_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv6 globally unique address associated with the network interface.</p>"""
    operator: NotRequired["capo_ec2.types.operator_response.OperatorResponse"]
    """<p>The service provider that manages the network interface.</p>"""
    associated_subnets: NotRequired[
        "capo_ec2.types.associated_subnet_list.AssociatedSubnetList"
    ]
    """<p>The subnets associated with this network interface.</p>"""
    availability_zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Availability Zone.</p>"""

associated_subnets instance-attribute

associated_subnets: NotRequired[AssociatedSubnetList]

The subnets associated with this network interface.

association instance-attribute

association: NotRequired[NetworkInterfaceAssociation]

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

attachment instance-attribute

attachment: NotRequired[NetworkInterfaceAttachment]

The network interface attachment.

availability_zone instance-attribute

availability_zone: NotRequired[String]

The Availability Zone.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[String]

The ID of the Availability Zone.

connection_tracking_configuration instance-attribute

connection_tracking_configuration: NotRequired[ConnectionTrackingConfiguration]

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

deny_all_igw_traffic instance-attribute

deny_all_igw_traffic: NotRequired[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.

description instance-attribute

description: NotRequired[String]

A description.

groups instance-attribute

groups: NotRequired[GroupIdentifierList]

Any security groups for the network interface.

interface_type instance-attribute

interface_type: NotRequired[NetworkInterfaceType]

The type of network interface.

ipv4_prefixes instance-attribute

ipv4_prefixes: NotRequired[Ipv4PrefixesList]

The IPv4 prefixes that are assigned to the network interface.

ipv6_address instance-attribute

ipv6_address: NotRequired[String]

The IPv6 globally unique address associated with the network interface.

ipv6_addresses instance-attribute

ipv6_addresses: NotRequired[NetworkInterfaceIpv6AddressesList]

The IPv6 addresses associated with the network interface.

ipv6_native instance-attribute

ipv6_native: NotRequired[Boolean]

Indicates whether this is an IPv6 only network interface.

ipv6_prefixes instance-attribute

ipv6_prefixes: NotRequired[Ipv6PrefixesList]

The IPv6 prefixes that are assigned to the network interface.

mac_address instance-attribute

mac_address: NotRequired[String]

The MAC address.

network_interface_id instance-attribute

network_interface_id: NotRequired[String]

The ID of the network interface.

operator instance-attribute

operator: NotRequired[OperatorResponse]

The service provider that manages the network interface.

outpost_arn instance-attribute

outpost_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Outpost.

owner_id instance-attribute

owner_id: NotRequired[String]

The Amazon Web Services account ID of the owner of the network interface.

private_dns_name instance-attribute

private_dns_name: NotRequired[String]

The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

private_ip_address instance-attribute

private_ip_address: NotRequired[String]

The IPv4 address of the network interface within the subnet.

private_ip_addresses instance-attribute

private_ip_addresses: NotRequired[NetworkInterfacePrivateIpAddressList]

The private IPv4 addresses associated with the network interface.

public_dns_name instance-attribute

public_dns_name: NotRequired[String]

A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

public_ip_dns_name_options instance-attribute

public_ip_dns_name_options: NotRequired[PublicIpDnsNameOptions]

Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

requester_id instance-attribute

requester_id: NotRequired[String]

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

requester_managed instance-attribute

requester_managed: NotRequired[Boolean]

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

source_dest_check instance-attribute

source_dest_check: NotRequired[Boolean]

Indicates whether source/destination checking is enabled.

status instance-attribute

status: NotRequired[NetworkInterfaceStatus]

The status of the network interface.

subnet_id instance-attribute

subnet_id: NotRequired[String]

The ID of the subnet.

tag_set instance-attribute

tag_set: NotRequired[TagList]

Any tags assigned to the network interface.

vpc_id instance-attribute

vpc_id: NotRequired[String]

The ID of the VPC.