dns_views

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

Overview

Name	dns_views
Type	Resource
Id	aws.route53globalresolver.dns_views

Fields

The following fields are returned by SELECT queries:

get_dns_view

Name	Datatype	Description
id	string	ID of the DNS view. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	Name of the DNS view. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	Amazon Resource Name (ARN) of the DNS view. (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 DNS view was creates on.
description	string	Description of the DNS view.
dnssec_validation	string	Specifies whether DNSSEC is enabled or disabled for the DNS view. (ENABLED, DISABLED)
edns_client_subnet	string	Specifies whether edns0 client subnet is enabled. (ENABLED, DISABLED)
firewall_rules_fail_open	string	Specifies the DNS Firewall failure mode configuration. When enabled, the DNS Firewall allows DNS queries to proceed if it's unable to properly evaluate them. When disabled, the DNS Firewall blocks DNS queries it's unable to evaluate. (ENABLED, DISABLED)
global_resolver_id	string	ID of the Global Resolver the DNS view is associated to. (pattern: <code>[-.a-zA-Z0-9]+</code>)
status	string	Operational status of the DNS view. (CREATING, OPERATIONAL, UPDATING, ENABLING, DISABLING, DISABLED, DELETING)
updated_at	string (date-time)	The time and date the DNS view was updated on.

list_dns_views

Name	Datatype	Description
id	string	The unique identifier of the DNS view. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the DNS view. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the DNS view. (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 DNS view was created.
description	string	A description of the DNS view.
dnssec_validation	string	Whether DNSSEC validation is enabled for the DNS view. (ENABLED, DISABLED)
edns_client_subnet	string	Whether EDNS Client Subnet injection is enabled for the DNS view. (ENABLED, DISABLED)
firewall_rules_fail_open	string	Whether firewall rules fail open when they cannot be evaluated. (ENABLED, DISABLED)
global_resolver_id	string	The ID of the global resolver that the DNS view is associated with. (pattern: <code>[-.a-zA-Z0-9]+</code>)
status	string	The current status of the DNS view. (CREATING, OPERATIONAL, UPDATING, ENABLING, DISABLING, DISABLED, DELETING)
updated_at	string (date-time)	The date and time when the DNS view was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dns_view	select	dns_view_id, region		Retrieves information about a DNS view. 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_dns_views	select	global_resolver_id, region	max_results, next_token	Lists all DNS views for a Route 53 Global Resolver 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_dns_view	insert	global_resolver_id, region, name		Creates a DNS view within a Route 53 Global Resolver. A DNS view models end users, user groups, networks, and devices, and serves as a parent resource that holds configurations controlling access, authorization, DNS firewall rules, and forwarding rules. 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_dns_view	update	dns_view_id, region		Updates the configuration of a DNS view. 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_dns_view	delete	dns_view_id, region		Deletes a DNS view. 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.
disable_dns_view	exec	dns_view_id, region		Disables a DNS view, preventing it from serving DNS queries. 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.
enable_dns_view	exec	dns_view_id, region		Enables a disabled DNS view, allowing it to serve DNS queries again. 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
dns_view_id	string	The unique identifier of the DNS view to enable.
global_resolver_id	string	The ID of the Route 53 Global Resolver to associate with this DNS view.
region	string	AWS region (default: us-east-1)
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_dns_view

Retrieves information about a DNS view. 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,
dnssec_validation,
edns_client_subnet,
firewall_rules_fail_open,
global_resolver_id,
status,
updated_at
FROM aws.route53globalresolver.dns_views
WHERE dns_view_id = '{{ dns_view_id }}' -- required
AND region = '{{ region }}' -- required
;

list_dns_views

Lists all DNS views for a Route 53 Global Resolver 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,
dnssec_validation,
edns_client_subnet,
firewall_rules_fail_open,
global_resolver_id,
status,
updated_at
FROM aws.route53globalresolver.dns_views
WHERE global_resolver_id = '{{ global_resolver_id }}' -- required
AND region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;

INSERT examples

create_dns_view

Creates a DNS view within a Route 53 Global Resolver. A DNS view models end users, user groups, networks, and devices, and serves as a parent resource that holds configurations controlling access, authorization, DNS firewall rules, and forwarding rules. 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.dns_views (
clientToken,
name,
dnssecValidation,
ednsClientSubnet,
firewallRulesFailOpen,
description,
tags,
global_resolver_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ name }}' /* required */,
'{{ dnssecValidation }}',
'{{ ednsClientSubnet }}',
'{{ firewallRulesFailOpen }}',
'{{ description }}',
'{{ tags }}',
'{{ global_resolver_id }}',
'{{ region }}'
RETURNING
id,
name,
arn,
client_token,
created_at,
description,
dnssec_validation,
edns_client_subnet,
firewall_rules_fail_open,
global_resolver_id,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: dns_views
props:
  - name: global_resolver_id
    value: "{{ global_resolver_id }}"
    description: Required parameter for the dns_views resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dns_views resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: dnssecValidation
    value: "{{ dnssecValidation }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: ednsClientSubnet
    value: "{{ ednsClientSubnet }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: firewallRulesFailOpen
    value: "{{ firewallRulesFailOpen }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_dns_view

Updates the configuration of a DNS view. 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.dns_views
SET 
name = '{{ name }}',
description = '{{ description }}',
dnssecValidation = '{{ dnssecValidation }}',
ednsClientSubnet = '{{ ednsClientSubnet }}',
firewallRulesFailOpen = '{{ firewallRulesFailOpen }}'
WHERE 
dns_view_id = '{{ dns_view_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
arn,
client_token,
created_at,
description,
dnssec_validation,
edns_client_subnet,
firewall_rules_fail_open,
global_resolver_id,
status,
updated_at;

DELETE examples

delete_dns_view

Deletes a DNS view. 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.dns_views
WHERE dns_view_id = '{{ dns_view_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disable_dns_view

Disables a DNS view, preventing it from serving DNS queries. 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.

EXEC aws.route53globalresolver.dns_views.disable_dns_view 
@dns_view_id='{{ dns_view_id }}' --required, 
@region='{{ region }}' --required
;

enable_dns_view

Enables a disabled DNS view, allowing it to serve DNS queries again. 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.

EXEC aws.route53globalresolver.dns_views.enable_dns_view 
@dns_view_id='{{ dns_view_id }}' --required, 
@region='{{ region }}' --required
;