CreateAccelerator - AWS Global Accelerator

CreateAccelerator

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example.

Important

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.

Request Syntax

{ "Enabled": boolean, "IdempotencyToken": "string", "IpAddresses": [ "string" ], "IpAddressType": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "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.

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, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

Type: Boolean

Required: No

IdempotencyToken

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

IpAddresses

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

Type: Array of strings

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

Required: No

IpAddressType

The value for the address type must be IPv4.

Type: String

Valid Values: IPV4

Required: No

Name

The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Tags

Create tags for an accelerator.

For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

Type: Array of Tag objects

Required: No

Response Syntax

{ "Accelerator": { "AcceleratorArn": "string", "CreatedTime": number, "DnsName": "string", "Enabled": boolean, "IpAddressType": "string", "IpSets": [ { "IpAddresses": [ "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

The accelerator that is created by specifying a listener and the supported IP address types.

Type: Accelerator object

Errors

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

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

LimitExceededException

Processing your request would cause you to exceed an AWS Global Accelerator limit.

HTTP Status Code: 400

Example

Create an accelerator

The following is an example of creating an accelerator with two tags, and the response (which does not include the tag information).

aws globalaccelerator create-accelerator --name ExampleAccelerator --tags Key="Name",Value="Example Name" Key="Project",Value="Example Project" --region us-west-2 --ip-addresses 192.0.2.250 198.51.100.52
{ "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleAccelerator", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "198.51.100.52" ], "IpFamily": "IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime": 1542394847.0, "LastModifiedTime": 1542394847.0 } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: