firewall_domains

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

Overview

Name	firewall_domains
Type	Resource
Id	aws.route53resolver.firewall_domains

Fields

The following fields are returned by SELECT queries:

list_firewall_domains

Name	Datatype	Description
domain	string	A list of the domains in the firewall domain list. This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_firewall_domains	select	region		Retrieves the domains that you have defined for the specified firewall domain list. A single call might return only a partial list of the domains. For information, see MaxResults.
update_firewall_domains	update	region, FirewallDomainListId, Operation, Domains		Updates the firewall domain list from an array of domain specifications.
import_firewall_domains	exec	region, FirewallDomainListId, Operation, DomainFileUrl		Imports domain names from a file into a domain list, for use in a DNS firewall rule group. Each domain specification in your domain list must satisfy the following requirements: It can optionally start with * (asterisk). With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen). It must be from 1-255 characters in length.

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
region	string	AWS region (default: us-east-1)

SELECT examples

list_firewall_domains

Retrieves the domains that you have defined for the specified firewall domain list. A single call might return only a partial list of the domains. For information, see MaxResults.

SELECT
domain
FROM aws.route53resolver.firewall_domains
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_firewall_domains

Updates the firewall domain list from an array of domain specifications.

UPDATE aws.route53resolver.firewall_domains
SET 
FirewallDomainListId = '{{ FirewallDomainListId }}',
Operation = '{{ Operation }}',
Domains = '{{ Domains }}'
WHERE 
region = '{{ region }}' --required
AND FirewallDomainListId = '{{ FirewallDomainListId }}' --required
AND Operation = '{{ Operation }}' --required
AND Domains = '{{ Domains }}' --required
RETURNING
id,
name,
status,
status_message;

Lifecycle Methods

import_firewall_domains

Imports domain names from a file into a domain list, for use in a DNS firewall rule group. Each domain specification in your domain list must satisfy the following requirements: It can optionally start with * (asterisk). With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen). It must be from 1-255 characters in length.

EXEC aws.route53resolver.firewall_domains.import_firewall_domains 
@region='{{ region }}' --required 
@@json=
'{
"FirewallDomainListId": "{{ FirewallDomainListId }}", 
"Operation": "{{ Operation }}", 
"DomainFileUrl": "{{ DomainFileUrl }}"
}'
;