The following is an example for updating a custom routing accelerator.
aws --region us-west-2 globalaccelerator update-custom-routing-accelerator
--accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh
--enabled
{ "Accelerator": {
"AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh",
"DnsName": "a1234567890abcdef.awsglobalaccelerator.com", "Status": "IN_PROGRESS",
"CreatedTime": 1605833295.0, "LastModifiedTime": 1605910135.0 }
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateCustomRoutingAcceleratorAttributes
Update the attributes for a custom routing accelerator.
Request Syntax
{ "AcceleratorArn": "string", "FlowLogsEnabled": boolean, "FlowLogsS3Bucket": "string", "FlowLogsS3Prefix": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 184).
The request accepts the following data in JSON format.
AcceleratorArn (p. 131)
The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
FlowLogsEnabled (p. 131)
Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.
Type: Boolean Required: No
FlowLogsS3Bucket (p. 131)
The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
Type: String
Length Constraints: Maximum length of 255.
Required: No
FlowLogsS3Prefix (p. 131)
Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
API Version 2018-08-08 131
Response Syntax
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id Type: String
Length Constraints: Maximum length of 255.
Required: No
Response Syntax
{ "AcceleratorAttributes": { "FlowLogsEnabled": boolean, "FlowLogsS3Bucket": "string", "FlowLogsS3Prefix": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AcceleratorAttributes (p. 132)
Updated custom routing accelerator.
Type: CustomRoutingAcceleratorAttributes (p. 159) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 186).
AcceleratorNotFoundException
The accelerator that you specified doesn't exist.
HTTP Status Code: 400 AccessDeniedException
You don't have access permission.
HTTP Status Code: 400 InternalServiceErrorException
There was an internal error for AWS Global Accelerator.
HTTP Status Code: 400 InvalidArgumentException
An argument that you specified is invalid.
HTTP Status Code: 400
Examples
Update attributes for an accelerator
The following is an example for updating a custom routing accelerator to enable flow logs.
aws globalaccelerator update-custom-routing-accelerator-attributes
--accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh
--flow-logs-enabled
--flow-logs-s3-bucket flowlogs-abc --flow-logs-s3-prefix bucketprefix-abc --region us-west-2
{ "AcceleratorAttributes": { "FlowLogsEnabled": true
"FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc }
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2018-08-08 133
UpdateCustomRoutingListener
UpdateCustomRoutingListener
Update a listener for a custom routing accelerator.
Request Syntax
{ "ListenerArn": "string", "PortRanges": [
{
"FromPort": number, "ToPort": number }
]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 184).
The request accepts the following data in JSON format.
ListenerArn (p. 134)
The Amazon Resource Name (ARN) of the listener to update.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes PortRanges (p. 134)
The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
Type: Array of PortRange (p. 181) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax
{
"Listener": {
"ListenerArn": "string", "PortRanges": [
{
"FromPort": number, "ToPort": number }
] }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Listener (p. 134)
Information for the updated listener for a custom routing accelerator.
Type: CustomRoutingListener (p. 165) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 186).
InternalServiceErrorException
There was an internal error for AWS Global Accelerator.
HTTP Status Code: 400 InvalidArgumentException
An argument that you specified is invalid.
HTTP Status Code: 400 InvalidPortRangeException
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
HTTP Status Code: 400 LimitExceededException
Processing your request would cause you to exceed an AWS Global Accelerator limit.
HTTP Status Code: 400 ListenerNotFoundException
The listener that you specified doesn't exist.
HTTP Status Code: 400