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	awscc.globalaccelerator.accelerators

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
accelerator_arn	string	The Amazon Resource Name (ARN) of the accelerator.
region	string	AWS region.

For more information, see AWS::GlobalAccelerator::Accelerator.

Methods

Name	Resource	Accessible by	Required Params
create_resource	accelerators	INSERT	Name, region
delete_resource	accelerators	DELETE	Identifier, region
update_resource	accelerators	UPDATE	Identifier, PatchDocument, region
list_resources	accelerators_list_only	SELECT	region
get_resource	accelerators	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.globalaccelerator.accelerators
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ accelerator_arn }}';

list (identifiers only)

Lists all accelerators in a region.

SELECT
  region,
  accelerator_arn
FROM awscc.globalaccelerator.accelerators_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.globalaccelerator.accelerators (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.globalaccelerator.accelerators (
  Name,
  IpAddressType,
  IpAddresses,
  Enabled,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ ip_address_type }}',
  '{{ ip_addresses }}',
  '{{ enabled }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: ip_address_type
      value: '{{ ip_address_type }}'
    - name: ip_addresses
      value:
        - '{{ ip_addresses[0] }}'
    - name: enabled
      value: '{{ enabled }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.globalaccelerator.accelerators
SET PatchDocument = string('{{ {
    "Name": name,
    "IpAddressType": ip_address_type,
    "IpAddresses": ip_addresses,
    "Enabled": enabled,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ accelerator_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.globalaccelerator.accelerators
WHERE
  Identifier = '{{ accelerator_arn }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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