firewall_domain_lists

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

Overview

Name	firewall_domain_lists
Type	Resource
Id	aws.route53resolver.firewall_domain_lists

Fields

The following fields are returned by SELECT queries:

get_firewall_domain_list

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the firewall domain list.
category	string	The category of the domain list.
creation_time	string	The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).
creator_request_id	string	A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
domain_count	integer	The number of domain names that are specified in the domain list.
id	string	The ID of the domain list.
managed_list_type	string	The type of the managed domain list, for example THREAT. (THREAT, CONTENT)
managed_owner_name	string	The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.
modification_time	string	The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	The name of the domain list. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)
status	string	The status of the domain list. (COMPLETE, COMPLETE_IMPORT_FAILED, IMPORTING, DELETING, UPDATING)
status_message	string	Additional information about the status of the list, if available.

list_firewall_domain_lists

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the firewall domain list metadata.
category	string	The category of the domain list.
creator_request_id	string	A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
id	string	The ID of the domain list.
managed_list_type	string	The type of the managed domain list, for example THREAT. (THREAT, CONTENT)
managed_owner_name	string	The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.
name	string	The name of the domain list. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_firewall_domain_list	select	region		Retrieves the specified firewall domain list.
list_firewall_domain_lists	select	region		Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains. A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.
create_firewall_domain_list	insert	region, CreatorRequestId		Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.
delete_firewall_domain_list	delete	region		Deletes the specified domain list.

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

get_firewall_domain_list

Retrieves the specified firewall domain list.

SELECT
arn,
category,
creation_time,
creator_request_id,
domain_count,
id,
managed_list_type,
managed_owner_name,
modification_time,
name,
status,
status_message
FROM aws.route53resolver.firewall_domain_lists
WHERE region = '{{ region }}' -- required
;

list_firewall_domain_lists

Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains. A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.

SELECT
arn,
category,
creator_request_id,
id,
managed_list_type,
managed_owner_name,
name
FROM aws.route53resolver.firewall_domain_lists
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_firewall_domain_list

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

INSERT INTO aws.route53resolver.firewall_domain_lists (
CreatorRequestId,
Name,
Tags,
region
)
SELECT 
'{{ CreatorRequestId }}' /* required */,
'{{ Name }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
firewall_domain_list
;

Manifest

# Description fields are for documentation purposes
- name: firewall_domain_lists
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the firewall_domain_lists resource.
  - name: CreatorRequestId
    value: "{{ CreatorRequestId }}"
    description: |
      A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
  - name: Name
    value: "{{ Name }}"
    description: |
      A name that lets you identify the domain list to manage and use it.
  - name: Tags
    description: |
      A list of the tag keys and values that you want to associate with the domain list.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_firewall_domain_list

Deletes the specified domain list.

DELETE FROM aws.route53resolver.firewall_domain_lists
WHERE region = '{{ region }}' --required
;