global_resolvers

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

Overview

Name	global_resolvers
Type	Resource
Id	aws.route53globalresolver.global_resolvers

Fields

The following fields are returned by SELECT queries:

get_global_resolver

Name	Datatype	Description
id	string	The ID of the Global Resolver. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the Global Resolver. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the Global Resolver. (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 date and time the Global Resolver was created.
description	string	The description of the Global Resolver.
dns_name	string	The hostname used by the customers' DNS clients for certification validation.
ip_address_type	string	The IP address type configured for the Global Resolver. (IPV4, DUAL_STACK)
ipv_4_addresses	array	List of anycast IPv4 addresses associated with the Global Resolver instance.
ipv_6_addresses	array	List of anycast IPv6 addresses associated with the Global Resolver instance. This field is only populated when ipAddressType is DUAL_STACK.
observability_region	string	The Amazon Web Services Regions in which the users' Global Resolver query resolution logs will be propagated.
regions	array	The Amazon Web Services Regions in which the Global Resolver operate.
status	string	The operational status of the Global Resolver. (CREATING, OPERATIONAL, UPDATING, DELETING)
updated_at	string (date-time)	The date and time the Global Resolver was updated.

list_global_resolvers

Name	Datatype	Description
id	string	The unique identifier of the global resolver. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the global resolver. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the global resolver. (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	The unique string that identifies the request and ensures idempotency.
created_at	string (date-time)	The date and time when the global resolver was created.
description	string	A description of the global resolver.
dns_name	string	The DNS name of the global resolver.
ip_address_type	string	The IP address type configured for the global resolver. (IPV4, DUAL_STACK)
ipv_4_addresses	array	The IPv4 addresses assigned to the global resolver.
ipv_6_addresses	array	The IPv6 addresses assigned to the global resolver. This field is only populated when ipAddressType is DUAL_STACK.
observability_region	string	The Amazon Web Services Region where observability data is collected for the global resolver.
regions	array	The Amazon Web Services Regions where the global resolver is deployed.
status	string	The current status of the global resolver. (CREATING, OPERATIONAL, UPDATING, DELETING)
updated_at	string (date-time)	The date and time when the global resolver was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_global_resolver	select	global_resolver_id, region		Retrieves information about a Route 53 Global Resolver instance. 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_global_resolvers	select	region	max_results, next_token	Lists all Route 53 Global Resolver instances in your account 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_global_resolver	insert	region, name, regions		Creates a new Route 53 Global Resolver instance. A Route 53 Global Resolver is a global, internet-accessible DNS resolver that provides secure DNS resolution for both public and private domains through global anycast IP addresses. 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_global_resolver	update	global_resolver_id, region		Updates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability Region. 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_global_resolver	delete	global_resolver_id, region		Deletes a Route 53 Global Resolver instance. This operation cannot be undone. All associated DNS views, access sources, tokens, and firewall rules are also deleted. 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
global_resolver_id	string	The unique identifier of the Route 53 Global Resolver to delete.
region	string	AWS region (default: us-east-1)
max_results	integer	The maximum number of Route 53 Global Resolver instances to return in the response. Valid range is 1-100.
next_token	string	The token for the next page of results. This value is returned in the response if there are more results to retrieve.

SELECT examples

get_global_resolver

Retrieves information about a Route 53 Global Resolver instance. 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,
description,
dns_name,
ip_address_type,
ipv_4_addresses,
ipv_6_addresses,
observability_region,
regions,
status,
updated_at
FROM aws.route53globalresolver.global_resolvers
WHERE global_resolver_id = '{{ global_resolver_id }}' -- required
AND region = '{{ region }}' -- required
;

list_global_resolvers

Lists all Route 53 Global Resolver instances in your account 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,
client_token,
created_at,
description,
dns_name,
ip_address_type,
ipv_4_addresses,
ipv_6_addresses,
observability_region,
regions,
status,
updated_at
FROM aws.route53globalresolver.global_resolvers
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;

INSERT examples

create_global_resolver

Creates a new Route 53 Global Resolver instance. A Route 53 Global Resolver is a global, internet-accessible DNS resolver that provides secure DNS resolution for both public and private domains through global anycast IP addresses. 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.global_resolvers (
clientToken,
description,
ipAddressType,
name,
observabilityRegion,
regions,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ description }}',
'{{ ipAddressType }}',
'{{ name }}' /* required */,
'{{ observabilityRegion }}',
'{{ regions }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
client_token,
created_at,
description,
dns_name,
ip_address_type,
ipv_4_addresses,
ipv_6_addresses,
observability_region,
regions,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: global_resolvers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the global_resolvers resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: description
    value: "{{ description }}"
  - name: ipAddressType
    value: "{{ ipAddressType }}"
    valid_values: ['IPV4', 'DUAL_STACK']
  - name: name
    value: "{{ name }}"
  - name: observabilityRegion
    value: "{{ observabilityRegion }}"
  - name: regions
    value:
      - "{{ regions }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_global_resolver

Updates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability Region. 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.global_resolvers
SET 
name = '{{ name }}',
observabilityRegion = '{{ observabilityRegion }}',
description = '{{ description }}',
ipAddressType = '{{ ipAddressType }}',
regions = '{{ regions }}'
WHERE 
global_resolver_id = '{{ global_resolver_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
arn,
client_token,
created_at,
description,
dns_name,
ip_address_type,
ipv_4_addresses,
ipv_6_addresses,
observability_region,
regions,
status,
updated_at;

DELETE examples

delete_global_resolver

Deletes a Route 53 Global Resolver instance. This operation cannot be undone. All associated DNS views, access sources, tokens, and firewall rules are also deleted. 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.global_resolvers
WHERE global_resolver_id = '{{ global_resolver_id }}' --required
AND region = '{{ region }}' --required
;