Skip to main content

accelerators

Creates, updates, deletes, gets or lists an accelerators resource.

Overview​

Nameaccelerators
TypeResource
Idaws.globalaccelerator.accelerators

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
created_timestring (date-time)The date and time that the accelerator was created.
dns_namestringThe 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 for an accelerator 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.
dual_stack_dns_namestringThe Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com. Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses. For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
enabledbooleanIndicates 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.
eventsarrayA history of changes that you make to an accelerator in Global Accelerator.
ip_address_typestringThe IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK. (IPV4, DUAL_STACK)
ip_setsarrayThe static IP addresses that Global Accelerator associates with the accelerator.
last_modified_timestring (date-time)The date and time that the accelerator was last modified.
namestringThe name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
statusstringDescribes the deployment status of the accelerator. (DEPLOYED, IN_PROGRESS)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_acceleratorselectregionDescribe an accelerator.
list_acceleratorsselectregionList the accelerators for an Amazon Web Services account.
create_acceleratorinsertregion, IdempotencyTokenCreate 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. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
update_acceleratorupdateregion, AcceleratorArnUpdate an accelerator to make changes, such as the following: Change the name of the accelerator. Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it. Enable the accelerator, if it is disabled. Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack. Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.
delete_acceleratordeleteregionDelete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Describe an accelerator.

SELECT
accelerator_arn,
created_time,
dns_name,
dual_stack_dns_name,
enabled,
events,
ip_address_type,
ip_sets,
last_modified_time,
name,
status
FROM aws.globalaccelerator.accelerators
WHERE region = '{{ region }}' -- required
;

INSERT examples​

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. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.

INSERT INTO aws.globalaccelerator.accelerators (
Name,
IpAddressType,
IpAddresses,
Enabled,
IdempotencyToken,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ IpAddressType }}',
'{{ IpAddresses }}',
{{ Enabled }},
'{{ IdempotencyToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
accelerator
;

UPDATE examples​

Update an accelerator to make changes, such as the following: Change the name of the accelerator. Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it. Enable the accelerator, if it is disabled. Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack. Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI commands.

UPDATE aws.globalaccelerator.accelerators
SET 
AcceleratorArn = '{{ AcceleratorArn }}',
Name = '{{ Name }}',
IpAddressType = '{{ IpAddressType }}',
IpAddresses = '{{ IpAddresses }}',
Enabled = {{ Enabled }}
WHERE 
region = '{{ region }}' --required
AND AcceleratorArn = '{{ AcceleratorArn }}' --required
RETURNING
accelerator;

DELETE examples​

Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.

DELETE FROM aws.globalaccelerator.accelerators
WHERE region = '{{ region }}' --required
;
Last updated on