AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . networkmanager ]

update-vpc-attachment

Description

Updates a VPC attachment.

See also: AWS API Documentation

Synopsis

  update-vpc-attachment
--attachment-id <value>
[--add-subnet-arns <value>]
[--remove-subnet-arns <value>]
[--options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--attachment-id (string)

The ID of the attachment.

--add-subnet-arns (list)

Adds a subnet ARN to the VPC attachment.

(string)

Syntax:

"string" "string" ...

--remove-subnet-arns (list)

Removes a subnet ARN from the attachment.

(string)

Syntax:

"string" "string" ...

--options (structure)

Additional options for updating the VPC attachment.

Ipv6Support -> (boolean)

Indicates whether IPv6 is supported.

ApplianceModeSupport -> (boolean)

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .

Shorthand Syntax:

Ipv6Support=boolean,ApplianceModeSupport=boolean

JSON Syntax:

{
  "Ipv6Support": true|false,
  "ApplianceModeSupport": true|false
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

VpcAttachment -> (structure)

Describes the updated VPC attachment.

Attachment -> (structure)

Provides details about the VPC attachment.

CoreNetworkId -> (string)

The ID of a core network.

CoreNetworkArn -> (string)

The ARN of a core network.

AttachmentId -> (string)

The ID of the attachment.

OwnerAccountId -> (string)

The ID of the attachment account owner.

AttachmentType -> (string)

The type of attachment.

State -> (string)

The state of the attachment.

EdgeLocation -> (string)

The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations .

EdgeLocations -> (list)

The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation .

(string)

ResourceArn -> (string)

The attachment resource ARN.

AttachmentPolicyRuleNumber -> (integer)

The policy rule number associated with the attachment.

SegmentName -> (string)

The name of the segment attachment.

NetworkFunctionGroupName -> (string)

The name of the network function group.

Tags -> (list)

The tags associated with the attachment.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Constraints: Maximum length of 256 characters.

ProposedSegmentChange -> (structure)

The attachment to move from one segment to another.

Tags -> (list)

The list of key-value tags that changed for the segment.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Constraints: Maximum length of 256 characters.

AttachmentPolicyRuleNumber -> (integer)

The rule number in the policy document that applies to this change.

SegmentName -> (string)

The name of the segment to change.

ProposedNetworkFunctionGroupChange -> (structure)

Describes a proposed change to a network function group associated with the attachment.

Tags -> (list)

The list of proposed changes to the key-value tags associated with the network function group.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Constraints: Maximum length of 256 characters.

AttachmentPolicyRuleNumber -> (integer)

The proposed new attachment policy rule number for the network function group.

NetworkFunctionGroupName -> (string)

The proposed name change for the network function group name.

CreatedAt -> (timestamp)

The timestamp when the attachment was created.

UpdatedAt -> (timestamp)

The timestamp when the attachment was last updated.

LastModificationErrors -> (list)

Describes the error associated with the attachment request.

(structure)

Describes the error associated with an attachment request.

Code -> (string)

The error code for the attachment request.

Message -> (string)

The message associated with the error code .

ResourceArn -> (string)

The ARN of the requested attachment resource.

RequestId -> (string)

The ID of the attachment request.

SubnetArns -> (list)

The subnet ARNs.

(string)

Options -> (structure)

Provides details about the VPC attachment.

Ipv6Support -> (boolean)

Indicates whether IPv6 is supported.

ApplianceModeSupport -> (boolean)

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .