[ aws . networkmanager ]
Updates an existing global network. 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-global-network
--global-network-id <value>
[--description <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--global-network-id
(string)
The ID of your global network.
--description
(string)
A description of the global network.
Length Constraints: Maximum length of 256 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 global network
The following update-global-network
example updates the description for global network global-network-01231231231231231
.
aws networkmanager update-global-network \
--global-network-id global-network-01231231231231231 \
--description "Head offices" \
--region us-west-2
Output:
{
"GlobalNetwork": {
"GlobalNetworkId": "global-network-01231231231231231",
"GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
"Description": "Head offices",
"CreatedAt": 1575553525.0,
"State": "UPDATING"
}
}
For more information, see Global Networks in the Transit Gateway Network Manager Guide.
GlobalNetwork -> (structure)
Information about the global network object.
GlobalNetworkId -> (string)
The ID of the global network.
GlobalNetworkArn -> (string)
The Amazon Resource Name (ARN) of the global network.
Description -> (string)
The description of the global network.
CreatedAt -> (timestamp)
The date and time that the global network was created.
State -> (string)
The state of the global network.
Tags -> (list)
The tags for the global network.
(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.