firewall_configs

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

Overview

Name	firewall_configs
Type	Resource
Id	aws.route53resolver.firewall_configs

Fields

The following fields are returned by SELECT queries:

get_firewall_config

Name	Datatype	Description
firewall_fail_open	string	Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply. By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query. If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them. This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association. (ENABLED, DISABLED, USE_LOCAL_RESOURCE_SETTING)
id	string	The ID of the firewall configuration.
owner_id	string	The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.
resource_id	string	The ID of the VPC that this firewall configuration applies to.

list_firewall_configs

Name	Datatype	Description
firewall_fail_open	string	Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply. By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query. If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them. This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association. (ENABLED, DISABLED, USE_LOCAL_RESOURCE_SETTING)
id	string	The ID of the firewall configuration.
owner_id	string	The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.
resource_id	string	The ID of the VPC that this firewall configuration applies to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_firewall_config	select	region		Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
list_firewall_configs	select	region		Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs. A single call might return only a partial list of the configurations. For information, see MaxResults.
update_firewall_config	update	region, ResourceId, FirewallFailOpen		Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

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_config

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

SELECT
firewall_fail_open,
id,
owner_id,
resource_id
FROM aws.route53resolver.firewall_configs
WHERE region = '{{ region }}' -- required
;

list_firewall_configs

Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs. A single call might return only a partial list of the configurations. For information, see MaxResults.

SELECT
firewall_fail_open,
id,
owner_id,
resource_id
FROM aws.route53resolver.firewall_configs
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_firewall_config

Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

UPDATE aws.route53resolver.firewall_configs
SET 
ResourceId = '{{ ResourceId }}',
FirewallFailOpen = '{{ FirewallFailOpen }}'
WHERE 
region = '{{ region }}' --required
AND ResourceId = '{{ ResourceId }}' --required
AND FirewallFailOpen = '{{ FirewallFailOpen }}' --required
RETURNING
firewall_config;