Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdateCustomRoutingAccelerator

Update a custom routing accelerator.

Request Syntax


{
   "AcceleratorArn": "string",
   "Enabled": boolean,
   "IpAddresses": [ "string" ],
   "IpAddressType": "string",
   "Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AcceleratorArn

The Amazon Resource Name (ARN) of the accelerator to update.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Enabled

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.

Type: Boolean

Required: No

IpAddresses

The IP addresses for an accelerator.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Length Constraints: Maximum length of 45.

Required: No

IpAddressType

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

Type: String

Valid Values: IPV4 | DUAL_STACK

Required: No

Name

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.

Type: String

Length Constraints: Maximum length of 255.

Required: No

Response Syntax


{
   "Accelerator": { 
      "AcceleratorArn": "string",
      "CreatedTime": number,
      "DnsName": "string",
      "Enabled": boolean,
      "IpAddressType": "string",
      "IpSets": [ 
         { 
            "IpAddresses": [ "string" ],
            "IpAddressFamily": "string",
            "IpFamily": "string"
         }
      ],
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "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.

Accelerator

Information about the updated custom routing accelerator.

Type: CustomRoutingAccelerator object

Errors

For information about the errors that are common to all actions, see Common Errors.

AcceleratorNotFoundException

The accelerator that you specified doesn't exist.

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 a custom routing accelerator

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",
        "Name": "testaccelerator",
        "IpAddressType": "IPV4",
        "Enabled": true,
        "IpSets": [
            {
                "IpAddresses": [
                   "192.0.2.250",
                   "198.51.100.52"
                ], 
                "IpFamily": "IPv4"
            }
        ]
        "DnsName": "a1234567890abcdef.awsglobalaccelerator.com",
        "Status": "IN_PROGRESS",
        "CreatedTime": 1605833295.0,
        "LastModifiedTime": 1605910135.0
    }
}