[ aws . networkmanager ]
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-link
--global-network-id <value>
--link-id <value>
[--description <value>]
[--type <value>]
[--bandwidth <value>]
[--provider <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--global-network-id
(string)
The ID of the global network.
--link-id
(string)
The ID of the link.
--description
(string)
A description of the link.
Length Constraints: Maximum length of 256 characters.
--type
(string)
The type of the link.
Length Constraints: Maximum length of 128 characters.
--bandwidth
(structure)
The upload and download speed in Mbps.
UploadSpeed -> (integer)
Upload speed in Mbps.
DownloadSpeed -> (integer)
Download speed in Mbps.
Shorthand Syntax:
UploadSpeed=integer,DownloadSpeed=integer
JSON Syntax:
{
"UploadSpeed": integer,
"DownloadSpeed": integer
}
--provider
(string)
The provider of the link.
Length Constraints: Maximum length of 128 characters.
--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.
To update a link
The following update-link
example updates the bandwidth information for link link-11112222aaaabbbb1
.
aws networkmanager update-link \
--global-network-id global-network-01231231231231231 \
--link-id link-11112222aaaabbbb1 \
--bandwidth UploadSpeed=20,DownloadSpeed=20 \
--region us-west-2
Output:
{
"Link": {
"LinkId": "link-11112222aaaabbbb1",
"LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
"GlobalNetworkId": "global-network-01231231231231231",
"SiteId": "site-444555aaabbb11223",
"Description": "VPN Link",
"Type": "broadband",
"Bandwidth": {
"UploadSpeed": 20,
"DownloadSpeed": 20
},
"Provider": "AnyCompany",
"CreatedAt": 1575555811.0,
"State": "UPDATING"
}
}
For more information, see Working with Links in the Transit Gateway Network Manager Guide.
Link -> (structure)
Information about the link.
LinkId -> (string)
The ID of the link.
LinkArn -> (string)
The Amazon Resource Name (ARN) of the link.
GlobalNetworkId -> (string)
The ID of the global network.
SiteId -> (string)
The ID of the site.
Description -> (string)
The description of the link.
Type -> (string)
The type of the link.
Bandwidth -> (structure)
The bandwidth for the link.
UploadSpeed -> (integer)
Upload speed in Mbps.
DownloadSpeed -> (integer)
Download speed in Mbps.
Provider -> (string)
The provider of the link.
CreatedAt -> (timestamp)
The date and time that the link was created.
State -> (string)
The state of the link.
Tags -> (list)
The tags for the link.
(structure)
Describes a tag.
Key -> (string)
The tag key.
Length Constraints: Maximum length of 128 characters.
Value -> (string)
The tag value.
Length Constraints: Maximum length of 256 characters.