Component: route53-resolver-dns-firewall
This component is responsible for provisioning Route 53 Resolver DNS Firewall resources, including Route 53 Resolver DNS Firewall, domain lists, firewall rule groups, firewall rules, and logging configuration.
Usage
Stack Level: Regional
Here's an example snippet for how to use this component.
# stacks/catalog/route53-resolver-dns-firewall/defaults.yaml
components:
terraform:
route53-resolver-dns-firewall/defaults:
metadata:
type: abstract
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
firewall_fail_open: "ENABLED"
query_log_enabled: true
logs_bucket_component_name: "route53-resolver-dns-firewall-logs-bucket"
domains_config:
allowed-domains:
# Concat the lists of domains passed in the `domains` field and loaded from the file `domains_file`
# The file is in the `components/terraform/route53-resolver-dns-firewall/config` folder
domains_file: "config/allowed_domains.txt"
domains: []
blocked-domains:
# Concat the lists of domains passed in the `domains` field and loaded from the file `domains_file`
# The file is in the `components/terraform/route53-resolver-dns-firewall/config` folder
domains_file: "config/blocked_domains.txt"
domains: []
rule_groups_config:
blocked-and-allowed-domains:
# 'priority' must be between 100 and 9900 exclusive
priority: 101
rules:
allowed-domains:
firewall_domain_list_name: "allowed-domains"
# 'priority' must be between 100 and 9900 exclusive
priority: 101
action: "ALLOW"
blocked-domains:
firewall_domain_list_name: "blocked-domains"
# 'priority' must be between 100 and 9900 exclusive
priority: 200
action: "BLOCK"
block_response: "NXDOMAIN"
# stacks/mixins/stage/dev.yaml
import:
- catalog/route53-resolver-dns-firewall/defaults
components:
terraform:
route53-resolver-dns-firewall/example:
metadata:
component: route53-resolver-dns-firewall
inherits:
- route53-resolver-dns-firewall/defaults
vars:
name: route53-dns-firewall-example
vpc_component_name: vpc
Execute the following command to provision the route53-resolver-dns-firewall/example
component using Atmos:
atmos terraform apply route53-resolver-dns-firewall/example -s <stack>
Requirements
Name | Version |
---|---|
terraform | >= 1.3.0 |
aws | >= 4.9.0 |
Providers
No providers.
Modules
Name | Source | Version |
---|---|---|
iam_roles | ../account-map/modules/iam-roles | n/a |
logs_bucket | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
route53_resolver_dns_firewall | cloudposse/route53-resolver-dns-firewall/aws | 0.2.1 |
this | cloudposse/label/null | 0.25.0 |
vpc | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
Resources
No resources.
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. | list(string) | [] | no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. | any |
| no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
domains_config | Map of Route 53 Resolver DNS Firewall domain configurations |
| n/a | yes |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
firewall_fail_open | Determines how Route 53 Resolver handles queries 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 blocks queries that it is unable to evaluate properly. If you enable this option, the failure mode is open. This approach favors availability over security. In this case, DNS Firewall allows queries to proceed if it is unable to properly evaluate them. Valid values: ENABLED, DISABLED. | string | "ENABLED" | no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . | number | null | no |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . | string | null | no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . | string | null | no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
logs_bucket_component_name | Flow logs bucket component name | string | null | no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
query_log_config_name | Route 53 Resolver query log config name. If omitted, the name will be generated by concatenating the ID from the context with the VPC ID | string | null | no |
query_log_enabled | Flag to enable/disable Route 53 Resolver query logging | bool | false | no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
region | AWS Region | string | n/a | yes |
rule_groups_config | Rule groups and rules configuration |
| n/a | yes |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
vpc_component_name | The name of a VPC component where the Network Firewall is provisioned | string | n/a | yes |
Outputs
Name | Description |
---|---|
domains | Route 53 Resolver DNS Firewall domain configurations |
query_log_config | Route 53 Resolver query logging configuration |
rule_group_associations | Route 53 Resolver DNS Firewall rule group associations |
rule_groups | Route 53 Resolver DNS Firewall rule groups |
rules | Route 53 Resolver DNS Firewall rules |
References
- Deploy centralized traffic filtering using AWS Network Firewall
- AWS Network Firewall – New Managed Firewall Service in VPC
- Deployment models for AWS Network Firewall
- Deployment models for AWS Network Firewall with VPC routing enhancements
- Inspection Deployment Models with AWS Network Firewall
- How to deploy AWS Network Firewall by using AWS Firewall Manager
- A Deep Dive into AWS Transit Gateway
- Appliance in a shared services VPC
- Quotas on Route 53 Resolver DNS Firewall
- Unified bad hosts
- cloudposse/terraform-aws-components - Cloud Posse's upstream component