Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ec2-modify-network-interface-attribute

Description

Modifies a network interface attribute. You can specify only one attribute at a time.

The short version of this command is ec2mnicatt.

Syntax

ec2-modify-network-interface-attribute NETWORKINTERFACE -d, --description DESCRIPTION -a, --attachment ATTACHMENT --delete-on-termination BOOLEAN --source-dest-check BOOLEAN --group-id GROUP_ID

Options

NameDescription

-d, --description DESCRIPTION

Changes the description of the network interface.

Type: String

Default: None

Required: Yes

Example: -d "My Second ENI"

-a, --attachment ATTACHMENT

Changes properties of the attachment.

Type: String

Default: None

Constraints: Must be used in conjunction with --delete-on-termination.

Required: Yes

Example: -a eni-attach-09703260 -delete-on-termination false

--delete-on-termination BOOLEAN

Sets whether the network interface shall be deleted when the network interface is detached.

Type: String

Default: None

Constraints: Must be used in conjunction with --attachment.

Required: Yes

Example: -a eni-attach-09703260 -delete-on-termination false

--source-dest-check BOOLEAN

Sets whether to enable the source/dest check on traffic through this network interface.

Type: String

Default: None

Valid values: true | false

Required: Yes

Example: --source-dest-check false

--group-id GROUP_ID

Replaces the security groups for this network interface.

Type: String

Default: None

Required: Yes

Example: --group-id sg-b90619d5 -groupd id sg-a92639c9

Common Options

OptionDescription

--region REGION

Overrides the region specified by the EC2_URL environment variable and the URL specified by the -U option.

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are.

Default: The value of the EC2_PRIVATE_KEY environment variable. If EC2_PRIVATE_KEY isn't set, you must specify this option.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate that identifies you to Amazon EC2.

Default: The value of the EC2_CERT environment variable. If EC2_CERT isn't set, you must specify this option.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns the name of the attribute that was modified.

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example adds a description to the network interface.

PROMPT> ec2-modify-network-interface-attribute eni-b35da6da -d "This is an ENI"
NETWORKINTERFACE    eni-b35da6da    description 

This example turns off source/destination checking for network traffic across the network interface.

PROMPT> ec2-modify-network-interface-attribute eni-b35da6da --source-dest-check false
NETWORKINTERFACE    eni-b35da6da    sourceDestCheck
SOURCEDESTCHECK    false 

This example changes the security group for the specified network interface.

PROMPT> ec2-modify-network-interface-attribute eni-b35da6da --group-id sg-8ea1bce2
NETWORKINTERFACE    eni-b35da6da    group
GROUPID             sg-8ea1bce2 

This example retains the network interface when it is detached from an instance.

PROMPT> ec2-modify-network-interface-attribute eni-b35da6da --delete-on-termination false -a eni-attach-083fda61
NETWORKINTERFACE    eni-b35da6da    attachment