Skip to main content

custom_routing_accelerators

Creates, updates, deletes, gets or lists a custom_routing_accelerators resource.

Overview​

Namecustom_routing_accelerators
TypeResource
Idaws.globalaccelerator.custom_routing_accelerators

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
accelerator_arnstringThe Amazon Resource Name (ARN) of the custom routing 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 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.
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.
ip_address_typestringThe IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4. (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_custom_routing_acceleratorselectregionDescribe a custom routing accelerator.
list_custom_routing_acceleratorsselectregionList the custom routing accelerators for an Amazon Web Services account.
create_custom_routing_acceleratorinsertregion, IdempotencyTokenCreate a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints. Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation. 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_custom_routing_acceleratorupdateregion, AcceleratorArnUpdate a custom routing accelerator.
delete_custom_routing_acceleratordeleteregionDelete a custom routing 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 a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. 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 a custom routing accelerator.

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

INSERT examples​

Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints. Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation. 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.custom_routing_accelerators (
Name,
IpAddressType,
IpAddresses,
Enabled,
IdempotencyToken,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ IpAddressType }}',
'{{ IpAddresses }}',
{{ Enabled }},
'{{ IdempotencyToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
accelerator
;

UPDATE examples​

Update a custom routing accelerator.

UPDATE aws.globalaccelerator.custom_routing_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 a custom routing 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 a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. 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.custom_routing_accelerators
WHERE region = '{{ region }}' --required
;
Last updated on