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 ]
Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
associate-link
--global-network-id <value>
--device-id <value>
--link-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--global-network-id
(string)
The ID of the global network.
--device-id
(string)
The ID of the device.
--link-id
(string)
The ID of the link.
--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.
See 'aws help' for descriptions of global parameters.
To associate a link
The following associate-link
example associates link link-11112222aaaabbbb1
with device device-07f6fd08867abc123
. The link and device are in the specified global network.
aws networkmanager associate-link \
--global-network-id global-network-01231231231231231 \
--device-id device-07f6fd08867abc123 \
--link-id link-11112222aaaabbbb1 \
--region us-west-2
Output:
{
"LinkAssociation": {
"GlobalNetworkId": "global-network-01231231231231231",
"DeviceId": "device-07f6fd08867abc123",
"LinkId": "link-11112222aaaabbbb1",
"LinkAssociationState": "PENDING"
}
}
For more information, see Device and Link Associations in the Transit Gateway Network Manager Guide.
LinkAssociation -> (structure)
The link association.
GlobalNetworkId -> (string)
The ID of the global network.DeviceId -> (string)
The device ID for the link association.LinkId -> (string)
The ID of the link.LinkAssociationState -> (string)
The state of the association.