accelerators

Creates, updates, deletes or gets an accelerator resource or lists accelerators in a region

Overview

Name	accelerators
Type	Resource
Description	Resource Type definition for AWS::GlobalAccelerator::Accelerator
Id	aws.globalaccelerator.accelerators

Fields

Name	Datatype	Description
name	string	Name of accelerator.
ip_address_type	string	IP Address type.
ip_addresses	array	The IP addresses from BYOIP Prefix pool.
enabled	boolean	Indicates whether an accelerator is enabled. The value is true or false.
dns_name	string	The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
ipv4_addresses	array	The IPv4 addresses assigned to the accelerator.
ipv6_addresses	array	The IPv6 addresses assigned if the accelerator is dualstack
dual_stack_dns_name	string	The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
accelerator_arn	string	The Amazon Resource Name (ARN) of the accelerator.
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all accelerators in a region.

SELECT
region,
name,
ip_address_type,
ip_addresses,
enabled,
dns_name,
ipv4_addresses,
ipv6_addresses,
dual_stack_dns_name,
accelerator_arn,
tags
FROM aws.globalaccelerator.accelerators
;

Gets all properties from an individual accelerator.

SELECT
region,
name,
ip_address_type,
ip_addresses,
enabled,
dns_name,
ipv4_addresses,
ipv6_addresses,
dual_stack_dns_name,
accelerator_arn,
tags
FROM aws.globalaccelerator.accelerators
WHERE data__Identifier = '<AcceleratorArn>';

INSERT example

Use the following StackQL query and manifest file to create a new accelerator resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.globalaccelerator.accelerators (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.globalaccelerator.accelerators (
 Name,
 IpAddressType,
 IpAddresses,
 Enabled,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ IpAddressType }}',
 '{{ IpAddresses }}',
 '{{ Enabled }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: accelerator
    props:
      - name: Name
        value: '{{ Name }}'
      - name: IpAddressType
        value: '{{ IpAddressType }}'
      - name: IpAddresses
        value:
          - '{{ IpAddresses[0] }}'
      - name: Enabled
        value: '{{ Enabled }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.globalaccelerator.accelerators
WHERE data__Identifier = '<AcceleratorArn>'
AND region = 'us-east-1';

Permissions

To operate on the accelerators resource, the following permissions are required:

Create

globalaccelerator:CreateAccelerator,
globalaccelerator:DescribeAccelerator,
globalaccelerator:TagResource

Read

globalaccelerator:DescribeAccelerator

Update

globalaccelerator:UpdateAccelerator,
globalaccelerator:TagResource,
globalaccelerator:UntagResource,
globalaccelerator:DescribeAccelerator

Delete

globalaccelerator:UpdateAccelerator,
globalaccelerator:DeleteAccelerator,
globalaccelerator:DescribeAccelerator

List

globalaccelerator:ListAccelerators