[ aws . directconnect ]

update-direct-connect-gateway

Description

Updates the name of a current Direct Connect gateway.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-direct-connect-gateway
--direct-connect-gateway-id <value>
--new-direct-connect-gateway-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--direct-connect-gateway-id (string)

The ID of the Direct Connect gateway to update.

--new-direct-connect-gateway-name (string)

The new name for the Direct Connect gateway.

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

See ‘aws help’ for descriptions of global parameters.

Output

directConnectGateway -> (structure)

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

directConnectGatewayId -> (string)

The ID of the Direct Connect gateway.

directConnectGatewayName -> (string)

The name of the Direct Connect gateway.

amazonSideAsn -> (long)

The autonomous system number (ASN) for the Amazon side of the connection.

ownerAccount -> (string)

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

directConnectGatewayState -> (string)

The state of the Direct Connect gateway. The following are the possible values:

• pending : The initial state after calling CreateDirectConnectGateway .

• available : The Direct Connect gateway is ready for use.

• deleting : The initial state after calling DeleteDirectConnectGateway .

• deleted : The Direct Connect gateway is deleted and cannot pass traffic.

stateChangeError -> (string)

The error message if the state of an object failed to advance.