update-connection¶

Description¶

Modifies an existing connection. Currently we support modifications to the connection’s description and/or bandwidth.

Synopsis¶

  update-connection
--identifier <value>
[--description <value>]
[--bandwidth <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--identifier (string) [required]

The identifier of the Connection that should be updated.

Constraints:

min: 1

max: 32

pattern: (mcc|lmcc)-[a-z0-9]{8}

--description (string)

An updated description to apply to the Connection

Constraints:

min: 1

max: 255

pattern: [-a-zA-Z0-9_ ]+

--bandwidth (string)

Request a new bandwidth size on the given Connection .

Note that changes to the size may be subject to additional policy, and does require the remote partner provider to acknowledge and permit this new bandwidth size.

Constraints:

min: 1

max: 8

pattern: \d+[MG]bps

--client-token (string)

Idempotency token used for the request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

connection -> (structure)

The resulting updated Connection

id -> (string) [required]

The short identifier of the connection object.

Constraints:

min: 1

max: 32

pattern: (mcc|lmcc)-[a-z0-9]{8}

arn -> (string) [required]

An ARN of a Connection object.

Constraints:

min: 59

max: 150

pattern: arn:aws[a-z-]*:interconnect:[^:]+:[0-9]{12}:connection/(mcc|lmcc)-[a-z0-9]{8}

description -> (string) [required]

A descriptive name for the connection.

Constraints:

min: 1

max: 255

pattern: [-a-zA-Z0-9_ ]+

bandwidth -> (string) [required]

The specific selected bandwidth of this connection.

Constraints:

min: 1

max: 8

pattern: \d+[MG]bps

attachPoint -> (tagged union structure) [required]

The Attach Point to which the connection should be associated.”

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: directConnectGateway, arn.

directConnectGateway -> (string)

Identifies an DirectConnect Gateway attach point by DirectConnectGatewayID.

Constraints:

min: 36

max: 36

pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

arn -> (string)

Identifies an attach point by full ARN.

Constraints:

min: 59

max: 150

pattern: arn:aws[a-z-]*:interconnect:[^:]+:[0-9]{12}:connection/(mcc|lmcc)-[a-z0-9]{8}

environmentId -> (string) [required]

The specific Environment this connection is placed upon.

Constraints:

min: 1

max: 64

provider -> (tagged union structure) [required]

The provider on the remote side of this Connection .

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: cloudServiceProvider, lastMileProvider.

cloudServiceProvider -> (string)

The provider’s name. Specifically, connections to/from this Cloud Service Provider will be considered Multicloud connections.

Constraints:

min: 0

max: 32

lastMileProvider -> (string)

The provider’s name. Specifically, connections to/from this Last Mile Provider will be considered LastMile connections.

Constraints:

min: 0

max: 32

location -> (string) [required]

The provider specific location on the remote side of this Connection

Constraints:

min: 0

max: 255

type -> (string) [required]

The specific product type of this Connection .

Constraints:

min: 5

max: 32

state -> (string) [required]

requested : The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

pending : The connection has been accepted and is being provisioned between AWS and the Partner.

available : The connection has been fully provisioned between AWS and the Partner.

deleting : The connection is being deleted.

deleted : The connection has been deleted.

failed : The connection has failed to be created.

updating : The connection is being updated.

Possible values:

available

requested

pending

down

deleting

deleted

failed

updating

sharedId -> (string) [required]

An identifier used by both AWS and the remote partner to identify the specific connection.

Constraints:

min: 36

max: 36

pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

billingTier -> (integer)

The billing tier this connection is currently assigned.

Constraints:

min: 0

max: 8

ownerAccount -> (string) [required]

The account that owns this Connection

Constraints:

min: 12

max: 12

pattern: [0-9]{12}

activationKey -> (string) [required]

The Activation Key associated to this connection.

Constraints:

min: 1

max: 2048

tags -> (map)

The tags on the Connection

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

Table of Contents

Feedback

User Guide