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 . directconnect ]
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
You must supply either the secretARN,
or the CKN/CAK (ckn
and cak
) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide .
See also: AWS API Documentation
associate-mac-sec-key
--connection-id <value>
[--secret-arn <value>]
[--ckn <value>]
[--cak <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>]
--connection-id
(string)
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections or DescribeLags to retrieve connection ID.
--secret-arn
(string)
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.
You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.
If you use this request parameter, you do not use the
ckn
andcak
request parameters.
--ckn
(string)
The MAC Security (MACsec) CKN to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the
cak
request parameter and not use thesecretARN
request parameter.
--cak
(string)
The MAC Security (MACsec) CAK to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the
ckn
request parameter and not use thesecretARN
request parameter.
--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.
--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.
--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.
--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.
connectionId -> (string)
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
macSecKeys -> (list)
The MAC Security (MACsec) security keys associated with the dedicated 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 LAGdisassociated
: 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.