Skip to main content
Sponsor @cloudposse

Module: firewall-manager

Terraform module to create and manage AWS Firewall Manager policies.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "label" {
  source = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  namespace = "eg"
  stage     = "prod"
  name      = "fms"
  delimiter = "-"

  tags = {
    "BusinessUnit" = "XYZ",
  }
}

module "vpc" {
  source  = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  cidr_block = "10.0.0.0/16"

  context = module.label.context
}

provider "aws" {
  region = "us-east-2"
}

provider "aws" {
  region = "us-east-2"
  alias  = "admin"
  assume_role {
    role_arn = "arn:aws:xyz"
  }
}

module "fms" {
  source = "cloudposse/firewall-manager/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  providers = {
    aws.admin = aws.admin
    aws       = aws
  }

  security_groups_usage_audit_policies = [
    {
      name               = "unused-sg"
      resource_type_list = ["AWS::EC2::SecurityGroup"]

      policy_data = {
        delete_unused_security_groups      = false
        coalesce_redundant_security_groups = false
      }
    }
  ]

  security_groups_content_audit_policies = [
    {
      name               = "maxmimum-allowed"
      resource_type_list = ["AWS::EC2::SecurityGroup"]

      policy_data = {
        security_group_action = "allow"
        security_groups       = [module.vpc.security_group_id]
      }
    }
  ]

  security_groups_common_policies = [
    {
      name               = "disabled-all"
      resource_type_list = ["AWS::EC2::SecurityGroup"]

      policy_data = {
        revert_manual_security_group_changes         = false
        exclusive_resource_security_group_management = false
        apply_to_all_ec2_instance_enis               = false
        security_groups                              = [module.vpc.security_group_id]
      }
    }
  ]

  waf_v2_policies = [
    {
      name               = "linux-policy"
      resource_type_list = ["AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ApiGateway::Stage"]

      policy_data = {
        default_action                        = "allow"
        override_customer_web_acl_association = false
        pre_process_rule_groups = [
          {
            "managedRuleGroupIdentifier" : {
              "vendorName" : "AWS",
              "managedRuleGroupName" : "AWSManagedRulesLinuxRuleSet",
              "version" : null
            },
            "overrideAction" : { "type" : "NONE" },
            "ruleGroupArn" : null,
            "excludeRules" : [],
            "ruleGroupType" : "ManagedRuleGroup"
          }
        ]
      }
    }
  ]

  context = module.label.context
}

Examples​

Here is an example of using this module:

Variables​

Required Variables​

security_groups_usage_audit_policies (list(any)) required

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
delete_unused_security_groups:
Whether to delete unused Security Groups.
Defaults to false.
coalesce_redundant_security_groups:
Whether to coalesce redundant Security Groups.
Defaults to false.


Optional Variables​

admin_account_enabled (bool) optional

Resource for aws_fms_admin_account is enabled and will be created or destroyed


Default value: true

admin_account_id (string) optional

The AWS account ID to associate to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. Defaults to the current account.


Default value: null

dns_firewall_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
pre_process_rule_groups:
A list of maps of pre-proccess rule groups in the format { "ruleGroupId": "rslvr-frg-1", "priority": 10 }.
post_process_rule_groups:
A list of maps post-proccess rule groups in the format { "ruleGroupId": "rslvr-frg-1", "priority": 10 }.



Default value: [ ]

firehose_arn (string) optional

Kinesis Firehose ARN used to create a Kinesis Firehose destination for WAF_V2 Rules. Conflicts with firehose_enabled


Default value: null

firehose_enabled (bool) optional

Create a Kinesis Firehose destination for WAF_V2 Rules. Conflicts with firehose_arn


Default value: false

network_firewall_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
stateless_rule_group_references:
A list of maps of configuration blocks containing references to the stateful rule groups that are used in the policy.
Format: { "resourceARN": "arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2", "priority": 10 }
stateless_default_actions:
A list of actions to take on a packet if it does not match any of the stateless rules in the policy.
You must specify one of the standard actions including: aws:drop, aws:pass, or aws:forward_to_sfe.
In addition, you can specify custom actions that are compatible with your standard action choice.
If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
stateless_fragment_default_actions:
A list of actions to take on a fragmented packet if it does not match any of the stateless rules in the policy.
You must specify one of the standard actions including: aws:drop, aws:pass, or aws:forward_to_sfe.
In addition, you can specify custom actions that are compatible with your standard action choice.
If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
stateless_custom_actions:
A list of maps describing the custom action definitions that are available for use in the firewall policy's stateless_default_actions.
Format: { "actionName": "custom1", "actionDefinition": { "publishMetricAction": { "dimensions": [ { "value": "dimension1" } ] } } }
stateful_rule_group_references_arns:
A list of ARNs of the stateful rule groups.
orchestration_config:
single_firewall_endpoint_per_vpc:
Whether to use single Firewall Endpoint per VPC.
Defaults to false.
allowed_ipv4_cidrs:
A list of allowed ipv4 cidrs.



Default value: [ ]

security_groups_common_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
revert_manual_security_group_changes:
Whether to revert manual Security Group changes.
Defaults to false.
exclusive_resource_security_group_management:
Wheter to exclusive resource Security Group management.
Defaults to false.
apply_to_all_ec2_instance_enis:
Whether to apply to all EC2 instance ENIs.
Defaults to false.
security_groups:
A list of Security Group IDs.



Default value: [ ]

security_groups_content_audit_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
security_group_action:
For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules.
For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Possible values: ALLOW, DENY.
security_groups:
A list of Security Group IDs.



Default value: [ ]

shield_advanced_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
delete_unused_fm_managed_resources:
If true, Firewall Manager will automatically remove protections from resources that leave the policy scope.
Defaults to false.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
automatic_response_status:
Status of shield automatic response.
Possible values: ENABLED|IGNORED|DISABLED.
Default is IGNORED.
automatic_response_action:
The automatic response action.
Possible values: BLOCK|COUNT.
Default is null.
override_customer_webacl_classic:
Whether to replace AWS WAF Classic web ACLs with this policy's AWS WAF v2 web ACLs where possible.
Possible values: true|false
Default is false.



Default value: [ ]

waf_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
default_action:
The action that you want AWS WAF to take.
Possible values: ALLOW, BLOCK or COUNT.
rule_groups:
A list of rule groups.



Default value: [ ]

waf_v2_policies (list(any)) optional

name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
default_action:
The action that you want AWS WAF to take.
Possible values: ALLOW, BLOCK or COUNT.
override_customer_web_acl_association:
Wheter to override customer Web ACL association
logging_configuration:
The WAFv2 Web ACL logging configuration.
pre_process_rule_groups:
A list of pre-proccess rule groups.
post_process_rule_groups:
A list of post-proccess rule groups.
custom_request_handling:
A custom header for custom request and response handling.
Defaults to null.
custom_response:
A custom response for the web request.
Defaults to null.
sampled_requests_enabled_for_default_actions:
Whether WAF should store a sampling of the web requests that match the rules.
Possible values: true or false.



Default value: [ ]

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.


Required: No

Default value: { }

attributes (list(string)) optional

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.


Required: No

Default value: [ ]

context (any) optional

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.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

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 be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.


Required: No

Default value: null

label_key_case (string) optional

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.


Required: No

Default value: null

label_order (list(string)) optional

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.


Required: No

Default value: null

label_value_case (string) optional

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.


Required: No

Default value: null

labels_as_tags (set(string)) optional

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 be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

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.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

admin_account

AWS Account ID of the designated admin account.

Dependencies​

Requirements​

  • terraform, version: >= 1.0
  • aws, version: >= 4.9.0

Providers​

  • aws, version: >= 4.9.0
  • aws, version: >= 4.9.0

Modules​

NameVersionSourceDescription
dns_firewall_label0.25.0cloudposse/label/nulln/a
firehose_label0.25.0cloudposse/label/nulln/a
firehose_s3_bucket4.3.0cloudposse/s3-bucket/awsn/a
network_firewall_label0.25.0cloudposse/label/nulln/a
security_groups_common_label0.25.0cloudposse/label/nulln/a
security_groups_content_audit_label0.25.0cloudposse/label/nulln/a
security_groups_usage_audit_label0.25.0cloudposse/label/nulln/a
shield_advanced_label0.25.0cloudposse/label/nulln/a
this0.25.0cloudposse/label/nulln/a
waf_label0.25.0cloudposse/label/nulln/a
waf_v2_label0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: