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 . globalaccelerator ]
update-custom-routing-accelerator
--accelerator-arn <value>
[--name <value>]
[--ip-address-type <value>]
[--ip-addresses <value>]
[--enabled | --no-enabled]
[--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>]
--accelerator-arn
(string)
The Amazon Resource Name (ARN) of the accelerator to update.
--name
(string)
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
--ip-address-type
(string)
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
Possible values:
IPV4
DUAL_STACK
--ip-addresses
(list)
The IP addresses for an accelerator.
(string)
Syntax:
"string" "string" ...
--enabled
| --no-enabled
(boolean)
Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
--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.
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 update a custom routing accelerator
The following update-custom-routing-accelerator
example modifies a custom routing accelerator to change the accelerator name.
aws globalaccelerator --region us-west-2 update-custom-routing-accelerator \
--accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \
--name ExampleCustomRoutingAcceleratorNew
Output:
{
"Accelerator": {
"AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh",
"IpAddressType": "IPV4",
"Name": "ExampleCustomRoutingAcceleratorNew",
"Enabled": true,
"Status": "IN_PROGRESS",
"IpSets": [
{
"IpAddresses": [
"192.0.2.250",
"198.51.100.52"
],
"IpFamily": "IPv4"
}
],
"DnsName":"a1234567890abcdef.awsglobalaccelerator.com",
"CreatedTime": 1232394847,
"LastModifiedTime": 1232395654
}
}
For more information, see Custom routing accelerators in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
Accelerator -> (structure)
Information about the updated custom routing accelerator.
AcceleratorArn -> (string)
The Amazon Resource Name (ARN) of the custom routing accelerator.Name -> (string)
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.IpAddressType -> (string)
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.Enabled -> (boolean)
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets -> (list)
The static IP addresses that Global Accelerator associates with the accelerator.
(structure)
A complex type for the set of IP addresses for an accelerator.
IpFamily -> (string)
IpFamily is deprecated and has been replaced by IpAddressFamily.IpAddresses -> (list)
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
(string)
IpAddressFamily -> (string)
The types of IP addresses included in this IP set.DnsName -> (string)
The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
If you have a dual-stack accelerator, you also have a second DNS name,
DualStackDnsName
, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide .
Status -> (string)
Describes the deployment status of the accelerator.CreatedTime -> (timestamp)
The date and time that the accelerator was created.LastModifiedTime -> (timestamp)
The date and time that the accelerator was last modified.