[ aws . directconnect ]
Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it’s the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
disassociate-connection-from-lag
--connection-id <value>
--lag-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--connection-id
(string)
The ID of the connection.
--lag-id
(string)
The ID of the LAG.
--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.
See ‘aws help’ for descriptions of global parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To disassociate a connection from a LAG
The following example disassociates the specified connection from the specified LAG.
Command:
aws directconnect disassociate-connection-from-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm
Output:
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fg9607vm",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "EqDC2",
"connectionName": "Con2ForLag",
"region": "us-east-1"
}
ownerAccount -> (string)
The ID of the Amazon Web Services account that owns the connection.
connectionId -> (string)
The ID of the connection.
connectionName -> (string)
The name of the connection.
connectionState -> (string)
The state of the connection. The following are the possible values:
ordering
: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested
: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending
: The connection has been approved and is being initialized.
available
: The network link is up and the connection is ready for use.
down
: The network link is down.
deleting
: The connection is being deleted.
deleted
: The connection has been deleted.
rejected
: A hosted connection in theordering
state enters therejected
state if it is deleted by the customer.
unknown
: The state of the connection is not available.
region -> (string)
The Amazon Web Services Region where the connection is located.
location -> (string)
The location of the connection.
bandwidth -> (string)
The bandwidth of the connection.
vlan -> (integer)
The ID of the VLAN.
partnerName -> (string)
The name of the Direct Connect service provider associated with the connection.
loaIssueTime -> (timestamp)
The time of the most recent call to DescribeLoa for this connection.
lagId -> (string)
The ID of the LAG.
awsDevice -> (string)
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable -> (boolean)
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 -> (string)
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId -> (string)
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy -> (string)
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags -> (list)
The tags associated with the connection.
(structure)
Information about a tag.
key -> (string)
The key.
value -> (string)
The value.
providerName -> (string)
The name of the service provider associated with the connection.
macSecCapable -> (boolean)
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus -> (string)
The MAC Security (MACsec) port link status of the connection.
The valid values are
Encryption Up
, which means that there is an active Connection Key Name, orEncryption Down
.
encryptionMode -> (string)
The MAC Security (MACsec) connection encryption mode.
The valid values are
no_encrypt
,should_encrypt
, andmust_encrypt
.
macSecKeys -> (list)
The MAC Security (MACsec) security keys associated with the connection.
(structure)
Information about the MAC Security (MACsec) secret key.
secretARN -> (string)
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn -> (string)
The Connection Key Name (CKN) for the MAC Security secret key.
state -> (string)
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating
: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated
: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating
: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated
: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.startOn -> (string)
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.