access_tokens

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

Overview

Name	access_tokens
Type	Resource
Id	aws.route53globalresolver.access_tokens

Fields

The following fields are returned by SELECT queries:

get_access_token

Name	Datatype	Description
id	string	ID of the token. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	Name of the token. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the token. (pattern: <code>arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}</code>)
client_token	string	A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.
created_at	string (date-time)	The time and date the token was created.
dns_view_id	string	ID of the DNS view the token is associated to. (pattern: <code>[-.a-zA-Z0-9]+</code>)
expires_at	string (date-time)	The token's expiration time and date.
global_resolver_id	string	ID of the Global Resolver. (pattern: <code>[-.a-zA-Z0-9]+</code>)
status	string	The operational status of the token. (CREATING, OPERATIONAL, DELETING)
updated_at	string (date-time)	The time and date the token was created.
value	string	The value of the token.

list_access_tokens

Name	Datatype	Description
id	string	The unique identifier of the token. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the token. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the token. (pattern: <code>arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}</code>)
created_at	string (date-time)	The date and time when the token was created.
dns_view_id	string	The ID of the DNS view associated with the token. (pattern: <code>[-.a-zA-Z0-9]+</code>)
expires_at	string (date-time)	The date and time when the token expires.
global_resolver_id	string	The ID of the global resolver associated with the token. (pattern: <code>[-.a-zA-Z0-9]+</code>)
status	string	The current status of the token. (CREATING, OPERATIONAL, DELETING)
updated_at	string (date-time)	The date and time when the token was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_access_token	select	access_token_id, region		Retrieves information about an access token. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
list_access_tokens	select	dns_view_id, region	max_results, next_token, filters	Lists all access tokens for a DNS view with pagination support. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
create_access_token	insert	dns_view_id, region		Creates an access token for a DNS view. Access tokens provide token-based authentication for DNS-over-HTTPS (DoH) and DNS-over-TLS (DoT) connections to the Route 53 Global Resolver. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
update_access_token	update	access_token_id, region, name		Updates the configuration of an access token. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.
delete_access_token	delete	access_token_id, region		Deletes an access token. This operation cannot be undone. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

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.

Name	Datatype	Description
access_token_id	string	The unique identifier of the access token to delete.
dns_view_id	string	The ID of the DNS view to associate with this token.
region	string	AWS region (default: us-east-1)
filters	object	Filtering parameters.
max_results	integer	The maximum number of results to retrieve in a single call.
next_token	string	A pagination token used for large sets of results that can't be returned in a single response.

SELECT examples

get_access_token

Retrieves information about an access token. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

SELECT
id,
name,
arn,
client_token,
created_at,
dns_view_id,
expires_at,
global_resolver_id,
status,
updated_at,
value
FROM aws.route53globalresolver.access_tokens
WHERE access_token_id = '{{ access_token_id }}' -- required
AND region = '{{ region }}' -- required
;

list_access_tokens

Lists all access tokens for a DNS view with pagination support. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

SELECT
id,
name,
arn,
created_at,
dns_view_id,
expires_at,
global_resolver_id,
status,
updated_at
FROM aws.route53globalresolver.access_tokens
WHERE dns_view_id = '{{ dns_view_id }}' -- required
AND region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND filters = '{{ filters }}'
;

INSERT examples

create_access_token

Creates an access token for a DNS view. Access tokens provide token-based authentication for DNS-over-HTTPS (DoH) and DNS-over-TLS (DoT) connections to the Route 53 Global Resolver. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

INSERT INTO aws.route53globalresolver.access_tokens (
clientToken,
expiresAt,
name,
tags,
dns_view_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ expiresAt }}',
'{{ name }}',
'{{ tags }}',
'{{ dns_view_id }}',
'{{ region }}'
RETURNING
id,
name,
arn,
client_token,
created_at,
dns_view_id,
expires_at,
status,
value
;

Manifest

# Description fields are for documentation purposes
- name: access_tokens
props:
  - name: dns_view_id
    value: "{{ dns_view_id }}"
    description: Required parameter for the access_tokens resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the access_tokens resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: expiresAt
    value: "{{ expiresAt }}"
  - name: name
    value: "{{ name }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_access_token

Updates the configuration of an access token. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

UPDATE aws.route53globalresolver.access_tokens
SET 
name = '{{ name }}'
WHERE 
access_token_id = '{{ access_token_id }}' --required
AND region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name;

DELETE examples

delete_access_token

Deletes an access token. This operation cannot be undone. Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

DELETE FROM aws.route53globalresolver.access_tokens
WHERE access_token_id = '{{ access_token_id }}' --required
AND region = '{{ region }}' --required
;