EC2 / Client / modify_network_interface_attribute

modify_network_interface_attribute

EC2.Client.modify_network_interface_attribute(**kwargs)

Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.

See also: AWS API Documentation

Request Syntax

response = client.modify_network_interface_attribute(
    Attachment={
        'AttachmentId': 'string',
        'DeleteOnTermination': True|False
    },
    Description={
        'Value': 'string'
    },
    DryRun=True|False,
    Groups=[
        'string',
    ],
    NetworkInterfaceId='string',
    SourceDestCheck={
        'Value': True|False
    },
    EnaSrdSpecification={
        'EnaSrdEnabled': True|False,
        'EnaSrdUdpSpecification': {
            'EnaSrdUdpEnabled': True|False
        }
    },
    EnablePrimaryIpv6=True|False
)

Parameters:

• Attachment (dict) –

  Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.

  • AttachmentId (string) –

    The ID of the network interface attachment.

  • DeleteOnTermination (boolean) –

    Indicates whether the network interface is deleted when the instance is terminated.

• Description (dict) –

  A description for the network interface.

  • Value (string) –

    The attribute value. The value is case-sensitive.

• 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) –

  Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it’s just the default security group in the VPC. You must specify the ID of the security group, not the name.

  • (string) –

• NetworkInterfaceId (string) –

  [REQUIRED]

  The ID of the network interface.

• SourceDestCheck (dict) –

  Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• EnaSrdSpecification (dict) –

  Updates the ENA Express configuration for the network interface that’s attached to the instance.

  • EnaSrdEnabled (boolean) –

    Indicates whether ENA Express is enabled for the network interface.

  • EnaSrdUdpSpecification (dict) –

    Configures ENA Express for UDP network traffic.

    • EnaSrdUdpEnabled (boolean) –

      Indicates whether UDP traffic uses ENA Express. To specify this setting, you must first enable ENA Express.

• EnablePrimaryIpv6 (boolean) – If you’re modifying 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.

Returns:

None

Examples

This example modifies the attachment attribute of the specified network interface.

response = client.modify_network_interface_attribute(
    Attachment={
        'AttachmentId': 'eni-attach-43348162',
        'DeleteOnTermination': False,
    },
    NetworkInterfaceId='eni-686ea200',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example modifies the description attribute of the specified network interface.

response = client.modify_network_interface_attribute(
    Description={
        'Value': 'My description',
    },
    NetworkInterfaceId='eni-686ea200',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example command modifies the groupSet attribute of the specified network interface.

response = client.modify_network_interface_attribute(
    Groups=[
        'sg-903004f8',
        'sg-1a2b3c4d',
    ],
    NetworkInterfaceId='eni-686ea200',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example command modifies the sourceDestCheck attribute of the specified network interface.

response = client.modify_network_interface_attribute(
    NetworkInterfaceId='eni-686ea200',
    SourceDestCheck={
        'Value': False,
    },
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}