firewall_domain_lists

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

Overview

Name	firewall_domain_lists
Type	Resource
Id	aws.route53globalresolver.firewall_domain_lists

Fields

The following fields are returned by SELECT queries:

get_firewall_domain_list

Name	Datatype	Description
id	string	ID of the domain list. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	Name of the domain list. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	Amazon Resource Name (ARN) of the domain list. (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 domain list was created.
description	string	The description of the domain list.
domain_count	integer	Number of domains in the domain list.
global_resolver_id	string	ID of the Global Resolver that the domain list is associated to. (pattern: <code>[-.a-zA-Z0-9]+</code>)
status	string	Operational status of the domain list. (CREATING, OPERATIONAL, UPDATING, DELETING)
status_message	string	Additional information about the status of the domain list.
updated_at	string (date-time)	The date and time the domain list was updated.

list_firewall_domain_lists

Name	Datatype	Description
id	string	The unique identifier of the firewall domain list. (pattern: <code>[-.a-zA-Z0-9]+</code>)
name	string	The name of the firewall domain list. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)</code>)
arn	string	The Amazon Resource Name (ARN) of the firewall domain list. (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 firewall domain list was created.
description	string	A description of the firewall domain list.
global_resolver_id	string	The ID of the global resolver that the firewall domain list is associated with. (pattern: <code>[-.a-zA-Z0-9]+</code>)
status	string	The current status of the firewall domain list. (CREATING, OPERATIONAL, UPDATING, DELETING)
updated_at	string (date-time)	The date and time when the firewall domain list was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_firewall_domain_list	select	firewall_domain_list_id, region		Retrieves information about a firewall domain list. 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_firewall_domain_lists	select	region	max_results, next_token, global_resolver_id	Lists all firewall domain lists 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_firewall_domain_list	insert	global_resolver_id, region, name		Creates a firewall domain list. Domain lists are reusable sets of domain specifications that you use in DNS firewall rules to allow, block, or alert on DNS queries to specific domains. 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_firewall_domain_list	delete	firewall_domain_list_id, region		Deletes a firewall domain list. 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
firewall_domain_list_id	string	The unique identifier of the firewall domain list to delete.
global_resolver_id	string	The ID of the Route 53 Global Resolver that the domain list will be associated with.
region	string	AWS region (default: us-east-1)
global_resolver_id	string	The ID of the Global Resolver that contains the DNS view the domain lists are associated to.
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_firewall_domain_list

Retrieves information about a firewall domain list. 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,
domain_count,
global_resolver_id,
status,
status_message,
updated_at
FROM aws.route53globalresolver.firewall_domain_lists
WHERE firewall_domain_list_id = '{{ firewall_domain_list_id }}' -- required
AND region = '{{ region }}' -- required
;

list_firewall_domain_lists

Lists all firewall domain lists 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,
created_at,
description,
global_resolver_id,
status,
updated_at
FROM aws.route53globalresolver.firewall_domain_lists
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND global_resolver_id = '{{ global_resolver_id }}'
;

INSERT examples

create_firewall_domain_list

Creates a firewall domain list. Domain lists are reusable sets of domain specifications that you use in DNS firewall rules to allow, block, or alert on DNS queries to specific domains. 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.firewall_domain_lists (
clientToken,
description,
name,
tags,
global_resolver_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ description }}',
'{{ name }}' /* required */,
'{{ tags }}',
'{{ global_resolver_id }}',
'{{ region }}'
RETURNING
id,
name,
arn,
created_at,
description,
domain_count,
global_resolver_id,
status,
updated_at
;

Manifest

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

DELETE examples

delete_firewall_domain_list

Deletes a firewall domain list. 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.firewall_domain_lists
WHERE firewall_domain_list_id = '{{ firewall_domain_list_id }}' --required
AND region = '{{ region }}' --required
;