Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/cloudposse/terraform-aws-firewall-manager

Terraform module to configure AWS Firewall Manager
https://github.com/cloudposse/terraform-aws-firewall-manager
aws compliance terraform terraform-modules
Last synced: 2 days ago
JSON representation
Terraform module to configure AWS Firewall Manager
Host: GitHub
URL: https://github.com/cloudposse/terraform-aws-firewall-manager
Owner: cloudposse
License: apache-2.0
Created: 2021-02-10T17:13:03.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-09-06T16:45:33.000Z (2 months ago)
Last Synced: 2024-09-06T19:57:05.871Z (2 months ago)
Topics: aws, compliance, terraform, terraform-modules
Language: HCL
Homepage: https://cloudposse.com/accelerate
Size: 2.03 MB
Stars: 16
Watchers: 16
Forks: 22
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: security_groups_common.tf
Awesome Lists containing this project

README

        




    




Terraform module to create and manage AWS Firewall Manager policies.

> [!TIP]

> #### 👽 Use Atmos with Terraform

> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. 


> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).

>

> 

> Watch demo of using Atmos with Terraform

> 


> Example of running atmos to manage infrastructure from our Quick Start tutorial.

> 

## Usage

For a complete example, see [examples/complete](examples/complete).

For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)

(which tests and deploys the example on AWS), see [test](test).

```hcl

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

}

```

> [!IMPORTANT]

> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation

> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version

> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic

> approach for updating versions to avoid unexpected changes.

## Examples

Here is an example of using this module:

- [`examples/complete`](https://github.com/cloudposse/terraform-aws-firewall-manager/examples/complete) - complete example of using this module

## Makefile Targets

```text

Available targets:

  help                                Help screen

  help/all                            Display help for all targets

  help/short                          This help short screen

  lint                                Lint terraform code

  test/%                              Run Terraform commands in the examples/complete folder; e.g. make test/plan

```

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.0 |

|  [aws](#requirement\_aws) | >= 4.9.0 |

## Providers

| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | >= 4.9.0 |

|  [aws.admin](#provider\_aws.admin) | >= 4.9.0 |

## Modules

| Name | Source | Version |

|------|--------|---------|

|  [dns\_firewall\_label](#module\_dns\_firewall\_label) | cloudposse/label/null | 0.25.0 |

|  [firehose\_label](#module\_firehose\_label) | cloudposse/label/null | 0.25.0 |

|  [firehose\_s3\_bucket](#module\_firehose\_s3\_bucket) | cloudposse/s3-bucket/aws | 4.3.0 |

|  [network\_firewall\_label](#module\_network\_firewall\_label) | cloudposse/label/null | 0.25.0 |

|  [security\_groups\_common\_label](#module\_security\_groups\_common\_label) | cloudposse/label/null | 0.25.0 |

|  [security\_groups\_content\_audit\_label](#module\_security\_groups\_content\_audit\_label) | cloudposse/label/null | 0.25.0 |

|  [security\_groups\_usage\_audit\_label](#module\_security\_groups\_usage\_audit\_label) | cloudposse/label/null | 0.25.0 |

|  [shield\_advanced\_label](#module\_shield\_advanced\_label) | cloudposse/label/null | 0.25.0 |

|  [this](#module\_this) | cloudposse/label/null | 0.25.0 |

|  [waf\_label](#module\_waf\_label) | cloudposse/label/null | 0.25.0 |

|  [waf\_v2\_label](#module\_waf\_v2\_label) | cloudposse/label/null | 0.25.0 |

## Resources

| Name | Type |

|------|------|

| [aws_fms_admin_account.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_admin_account) | resource |

| [aws_fms_policy.dns_firewall](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.network_firewall](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.security_groups_common](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.security_groups_content_audit](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.security_groups_usage_audit](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.shield_advanced](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.waf](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_fms_policy.waf_v2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_policy) | resource |

| [aws_iam_role.firehose_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |

| [aws_kinesis_firehose_delivery_stream.firehose_stream](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kinesis_firehose_delivery_stream) | resource |

| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_tag\_map](#input\_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 |

|  [admin\_account\_enabled](#input\_admin\_account\_enabled) | Resource for aws\_fms\_admin\_account is enabled and will be created or destroyed | `bool` | `true` | no |

|  [admin\_account\_id](#input\_admin\_account\_id) | 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. | `string` | `null` | no |

|  [attributes](#input\_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](#input\_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` | 
{
  "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
} | no |

|  [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |

|  [descriptor\_formats](#input\_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
`{
   format = string
   labels = list(string)
}`
(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). | `any` | `{}` | no |

|  [dns\_firewall\_policies](#input\_dns\_firewall\_policies) | 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 }`. | `list(any)` | `[]` | no |

|  [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |

|  [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |

|  [firehose\_arn](#input\_firehose\_arn) | Kinesis Firehose ARN used to create a Kinesis Firehose destination for WAF\_V2 Rules. Conflicts with `firehose_enabled` | `string` | `null` | no |

|  [firehose\_enabled](#input\_firehose\_enabled) | Create a Kinesis Firehose destination for WAF\_V2 Rules. Conflicts with `firehose_arn` | `bool` | `false` | no |

|  [id\_length\_limit](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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 be
  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | [
  "default"
] | no |

|  [name](#input\_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](#input\_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 |

|  [network\_firewall\_policies](#input\_network\_firewall\_policies) | 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. | `list(any)` | `[]` | no |

|  [regex\_replace\_chars](#input\_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 |

|  [security\_groups\_common\_policies](#input\_security\_groups\_common\_policies) | 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. | `list(any)` | `[]` | no |

|  [security\_groups\_content\_audit\_policies](#input\_security\_groups\_content\_audit\_policies) | 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. | `list(any)` | `[]` | no |

|  [security\_groups\_usage\_audit\_policies](#input\_security\_groups\_usage\_audit\_policies) | 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`. | `list(any)` | n/a | yes |

|  [shield\_advanced\_policies](#input\_shield\_advanced\_policies) | 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. | `list(any)` | `[]` | no |

|  [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |

|  [tags](#input\_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](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |

|  [waf\_policies](#input\_waf\_policies) | 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. | `list(any)` | `[]` | no |

|  [waf\_v2\_policies](#input\_waf\_v2\_policies) | 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`. | `list(any)` | `[]` | no |

## Outputs

| Name | Description |

|------|-------------|

|  [admin\_account](#output\_admin\_account) | AWS Account ID of the designated admin account. |

## Related Projects

Check out these related projects.

- [terraform-null-label](https://github.com/cloudposse/terraform-null-label) - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

## References

For additional context, refer to some of these links.

- [Terraform Standard Module Structure](https://www.terraform.io/docs/modules/index.html#standard-module-structure) - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.

- [Terraform Module Requirements](https://www.terraform.io/docs/registry/modules/publish.html#requirements) - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.

- [Terraform `random_integer` Resource](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/integer) - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.

- [Terraform Version Pinning](https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version) - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

> [!TIP]

> #### Use Terraform Reference Architectures for AWS

>

> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.

>

> ✅ We build it together with your team.


> ✅ Your team owns everything.


> ✅ 100% Open Source and backed by fanatical support.


>

> 

> 📚 Learn More

>

> 


>

> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-firewall-manager&utm_content=commercial_support) for funded startups and enterprises.

>

> *Your team can operate like a pro today.*

>

> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

> #### Day-0:  Your Foundation for Success

> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.

> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

>

> 

>

> #### Day-2: Your Operational Mastery

> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

>

> 

> 

## ✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:



  



For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-firewall-manager/issues).

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-firewall-manager/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).

 2. **Fork** the repo on GitHub

 3. **Clone** the project to your own machine

 4. **Commit** changes to your own branch

 5. **Push** your work back up to your fork

 6. Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!

### 🌎 Slack Community

Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-firewall-manager&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.

### 📰 Newsletter

Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-firewall-manager&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.

Dropped straight into your Inbox every week — and usually a 5-minute read.

### 📆 Office Hours 

[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-firewall-manager&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.

It's **FREE** for everyone!

## License



Preamble to the Apache License, Version 2.0







Complete license is available in the [`LICENSE`](LICENSE) file.

```text

Licensed to the Apache Software Foundation (ASF) under one

or more contributor license agreements.  See the NOTICE file

distributed with this work for additional information

regarding copyright ownership.  The ASF licenses this file

to you under the Apache License, Version 2.0 (the

"License"); you may not use this file except in compliance

with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,

software distributed under the License is distributed on an

"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

KIND, either express or implied.  See the License for the

specific language governing permissions and limitations

under the License.

```

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## Copyrights

Copyright © 2021-2024 [Cloud Posse, LLC](https://cloudposse.com)