AWS::FMS::Policy - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::FMS::Policy

An AWS Firewall Manager policy.

Firewall Manager provides the following types of policies:

  • An AWS Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.

  • An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.

  • An AWS WAF Classic policy, which defines a rule group. AWS WAF Classic doesn't support rule groups in Amazon CloudFront, so, to create AWS WAF Classic policies through CloudFront, you first need to create your rule groups outside of CloudFront.

  • A security group policy, which manages VPC security groups across your AWS organization.

  • An AWS Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.

  • A DNS Firewall policy, which provides Amazon Route 53 Resolver DNS Firewall rules to filter DNS queries for specified Amazon VPCs.

  • A third-party firewall policy, which manages a third-party firewall service.

Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.

These policies require some setup to use. For more information, see the sections on prerequisites and getting started under AWS Firewall Manager.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::FMS::Policy",
  "Properties" : {
      "DeleteAllPolicyResources" : Boolean,
      "ExcludeMap" : IEMap,
      "ExcludeResourceTags" : Boolean,
      "IncludeMap" : IEMap,
      "PolicyDescription" : String,
      "PolicyName" : String,
      "RemediationEnabled" : Boolean,
      "ResourcesCleanUp" : Boolean,
      "ResourceSetIds" : [ String, ... ],
      "ResourceTags" : [ ResourceTag, ... ],
      "ResourceType" : String,
      "ResourceTypeList" : [ String, ... ],
      "SecurityServicePolicyData" : SecurityServicePolicyData,
      "Tags" : [ PolicyTag, ... ]
    }
}

Properties

DeleteAllPolicyResources

Used when deleting a policy. If true, Firewall Manager performs cleanup according to the policy type.

For AWS WAF and Shield Advanced policies, Firewall Manager does the following:

  • Deletes rule groups created by Firewall Manager

  • Removes web ACLs from in-scope resources

  • Deletes web ACLs that contain no rules or rule groups

For security group policies, Firewall Manager does the following for each security group in the policy:

  • Disassociates the security group from in-scope resources

  • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

Required: No

Type: Boolean

Update requires: No interruption

ExcludeMap

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

  • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

  • Specify OUs by setting the key to ORGUNIT. For example, the following is a valid map: {“ORGUNIT” : [“ouid111”, “ouid112”]}.

  • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORGUNIT” : [“ouid111”, “ouid112”]}.

Required: No

Type: IEMap

Update requires: No interruption

ExcludeResourceTags

Used only when tags are specified in the ResourceTags property. If this property is True, resources with the specified tags are not in scope of the policy. If it's False, only resources with the specified tags are in scope of the policy.

Required: Yes

Type: Boolean

Update requires: No interruption

IncludeMap

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

  • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

  • Specify OUs by setting the key to ORGUNIT. For example, the following is a valid map: {“ORGUNIT” : [“ouid111”, “ouid112”]}.

  • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORGUNIT” : [“ouid111”, “ouid112”]}.

Required: No

Type: IEMap

Update requires: No interruption

PolicyDescription

The definition of the AWS Network Firewall firewall policy.

Required: No

Type: String

Pattern: ^([a-zA-Z0-9_.:/=+\-@\s]+)$

Maximum: 256

Update requires: No interruption

PolicyName

The name of the AWS Firewall Manager policy.

Required: Yes

Type: String

Pattern: ^([a-zA-Z0-9_.:/=+\-@\s]+)$

Minimum: 1

Maximum: 1024

Update requires: No interruption

RemediationEnabled

Indicates if the policy should be automatically applied to new resources.

Required: Yes

Type: Boolean

Update requires: No interruption

ResourcesCleanUp

Indicates whether AWS Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or AWS WAF Classic policies.

Required: No

Type: Boolean

Update requires: No interruption

ResourceSetIds

The unique identifiers of the resource sets used by the policy.

Required: No

Type: Array of String

Update requires: No interruption

ResourceTags

An array of ResourceTag objects, used to explicitly include resources in the policy scope or explicitly exclude them. If this isn't set, then tags aren't used to modify policy scope. See also ExcludeResourceTags.

Required: No

Type: Array of ResourceTag

Maximum: 8

Update requires: No interruption

ResourceType

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

The following are valid resource types for each Firewall Manager policy type:

  • AWS WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution, and AWS::ElasticLoadBalancingV2::LoadBalancer.

  • AWS WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and AWS::CloudFront::Distribution.

  • DNS Firewall, AWS Network Firewall, and third-party firewall - AWS::EC2::VPC.

  • AWS Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution.

  • Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance.

  • Security group usage audit - AWS::EC2::SecurityGroup.

Required: No

Type: String

Pattern: ^([^\s]*)$

Minimum: 1

Maximum: 128

Update requires: No interruption

ResourceTypeList

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.

Required: No

Type: Array of String

Update requires: No interruption

SecurityServicePolicyData

Details about the security service that is being used to protect the resources.

This contains the following settings:

  • Type - Indicates the service type that the policy uses to protect the resource. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.

    Valid values: DNS_FIREWALL | NETWORK_FIREWALL | SECURITY_GROUPS_COMMON | SECURITY_GROUPS_CONTENT_AUDIT | SECURITY_GROUPS_USAGE_AUDIT | SHIELD_ADVANCED | THIRD_PARTY_FIREWALL | WAFV2 | WAF

  • ManagedServiceData - Details about the service that are specific to the service type, in JSON format.

    • Example: DNS_FIREWALL

      "{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}"

      Note

      Valid values for preProcessRuleGroups are between 1 and 99. Valid values for postProcessRuleGroups are between 9901 and 10000.

    • Example: NETWORK_FIREWALL - Centralized deployment model

      "{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}"

      To use the distributed deployment model, you must set FirewallDeploymentModel to DISTRIBUTED.

    • Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration

      "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"

      With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set FirewallDeploymentModel to DISTRIBUTED.

    • Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone configuration and route management

      "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"

      To use the distributed deployment model, you must set FirewallDeploymentModel to DISTRIBUTED.

    • Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration

      "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ \"10.0.0.0/28\"]}]} },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"

      With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. To configure the Availability Zones in firewallCreationConfig, specify either the availabilityZoneName or availabilityZoneId parameter, not both parameters.

      To use the distributed deployment model, you must set FirewallDeploymentModel to DISTRIBUTED.

    • Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration and route management

      "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"

      To use the distributed deployment model, you must set FirewallDeploymentModel to DISTRIBUTED.

    • Example: THIRD_PARTY_FIREWALL - Centralized deployment model

      Replace THIRD_PARTY_FIREWALL_NAME with the third-party firewall name.

      "{ \"type\":\"THIRD_PARTY_FIREWALL\", \"thirdPartyFirewall\":\"THIRD_PARTY_FIREWALL_NAME\", \"thirdPartyFirewallConfig\":{ \"thirdPartyFirewallPolicyList\":[\"global-1\"] },\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}"

      To use the distributed deployment model, you must set FirewallDeploymentModel to CENTRALIZED.

    • Example: THIRD_PARTY_FIREWALL - Distributed deployment model

      Replace THIRD_PARTY_FIREWALL_NAME with the third-party firewall name.

      "{\"type\":\"THIRD_PARTY_FIREWALL\",\"thirdPartyFirewall\":\"THIRD_PARTY_FIREWALL_NAME\",\"thirdPartyFirewallConfig\":{\"thirdPartyFirewallPolicyList\":[\"global-1\"] },\"firewallDeploymentModel\":{ \"distributedFirewallDeploymentModel\":{ \"distributedFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{ \"availabilityZoneConfigList\":[ {\"availabilityZoneName\":\"${AvailabilityZone}\" } ] } }, \"allowedIPV4CidrList\":[ ] } } } }"

      To use the distributed deployment model, you must set FirewallDeploymentModel to DISTRIBUTED.

    • Specification for SHIELD_ADVANCED for Amazon CloudFront distributions

      "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}"

      For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}"

      The default value for automaticResponseStatus is IGNORED. The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED. The default value for overrideCustomerWebaclClassic is false.

      For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.

    • Example: WAFV2

      "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"

      In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD.

    • Example: AWS WAF Classic

      "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"

    • Example: WAFV2 - AWS Firewall Manager support for AWS WAF managed rule group versioning

      "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"

      To use a specific version of a AWS WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the AWS WAF managed rule group.

    • Example: SECURITY_GROUPS_COMMON

      "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"

    • Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns

      "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"

    • Example: SECURITY_GROUPS_CONTENT_AUDIT

      "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"

      The security group action for content audit can be ALLOW or DENY. 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.

    • Example: SECURITY_GROUPS_USAGE_AUDIT

      "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"

Required: Yes

Type: SecurityServicePolicyData

Update requires: No interruption

Tags

A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

Required: No

Type: Array of PolicyTag

Update requires: No interruption

Return values

Ref

The Ref for this resource returns the PolicyId.

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the policy.

Id

The ID of the policy.

Examples

Create a Firewall Manager AWS WAF policy

The following shows an example Firewall Manager WAF policy for the latest version of AWS WAF.

YAML

PolicyWAFv2:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: Policy
      RemediationEnabled: false
      ResourceType: AWS::ElasticLoadBalancingV2::LoadBalancer
      SecurityServicePolicyData:
        Type: WAFV2
        ManagedServiceData: !Sub '{"type":"WAFV2",
                                  "preProcessRuleGroups":[{
                                  "ruleGroupType":"RuleGroup",
                                  "ruleGroupArn":"${RuleGroup.Arn}",
                                  "overrideAction":{"type":"NONE"}}],
                                  "postProcessRuleGroups":[],
                                  "defaultAction":{"type":"BLOCK"}}'

JSON

"PolicyWAFv2": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": false,
        "PolicyName": "Policy",
        "RemediationEnabled": false,
        "ResourceType": "AWS::ElasticLoadBalancingV2::LoadBalancer",
        "SecurityServicePolicyData": {
            "Type": "WAFV2",
            "ManagedServiceData": {
                "Fn::Sub": "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupType\":\"RuleGroup,\"ruleGroupArn\":\"${RuleGroup.Arn}\",\"overrideAction\":{\"type\":\"NONE\"}}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"BLOCK\"}}"
            }
        }
    }
}

Create a Firewall Manager AWS WAF Classic policy

The following shows an example Firewall Manager AWS WAF Classic policy.

YAML

PolicyWAF:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: Policy
      RemediationEnabled: false
      ResourceType: AWS::ElasticLoadBalancingV2::LoadBalancer
      SecurityServicePolicyData:
        Type: WAF
        ManagedServiceData: !Sub '{"type":"WAF",
                                  "defaultAction":{"type":"BLOCK"},
                                  "overrideCustomerWebACLAssociation":false,
                                  "ruleGroups":[
                                    {
                                      "id":"${RuleGroupId}",
                                      "overrideAction":{"type":"NONE"}
                                    }
                                  ]}'

JSON

"PolicyWAF": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": false,
        "PolicyName": "Policy",
        "RemediationEnabled": false,
        "ResourceType": "AWS::ElasticLoadBalancingV2::LoadBalancer",
        "SecurityServicePolicyData": {
            "Type": "WAF",
            "ManagedServiceData": {
                "Fn::Sub": "{\"type\":\"WAF\",\"defaultAction\":{\"type\":\"BLOCK\"},\"overrideCustomerWebACLAssociation\":false,\"ruleGroups\":[{\"id\":\"${RuleGroupId}\",\"overrideAction\":{\"type\":\"NONE\"}}]}"
            }
        }
    }
}

Create a Firewall Manager Shield Advanced policy

The following shows an example Firewall Manager Shield Advanced policy. This example uses account and resource tag specifications to limit the scope of the policy.

YAML

Policy:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: true
      ResourceTags:
        - Key: resourceTag1
          Value: value
        - Key: resourceTag2
          Value: value
      IncludeMap:
        ACCOUNT:
          - !Ref AWS::AccountId
      PolicyName: TaggedPolicy
      RemediationEnabled: false
      ResourceType: ResourceTypeList
      ResourceTypeList:
        - AWS::ElasticLoadBalancingV2::LoadBalancer
        - AWS::EC2::EIP
      SecurityServicePolicyData:
        Type: SHIELD_ADVANCED
      DeleteAllPolicyResources: false
      Tags:
        - Key: tag1
          Value: value
        - Key: tag2
          Value: value

JSON

"Policy": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": true,
        "ResourceTags": [
            {
                "Key": "resourceTag1",
                "Value": "value"
            },
            {
                "Key": "resourceTag2",
                "Value": "value"
            }
          ],
          "IncludeMap": {
              "ACCOUNT": [
                {
                  "Ref": "AWS::AccountId"
                }
              ]
          },
          "PolicyName": "TaggedPolicy",
          "RemediationEnabled": false,
          "ResourceType": "ResourceTypeList",
          "ResourceTypeList": [
              "AWS::ElasticLoadBalancingV2::LoadBalancer",
              "AWS::EC2::EIP"
          ],
          "SecurityServicePolicyData": {
              "Type": "SHIELD_ADVANCED"
          },
          "Tags": [
              {
                "Key": "tag1",
                "Value": "value"
              },
              {
              "Key": "tag2",
              "Value": "value"
            }
        ]
    }
}

Create a Firewall Manager common security group policy

The following shows an example Firewall Manager common security group policy.

YAML

Policy:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: SecurityGroupsCommonsPolicy
      RemediationEnabled: false
      ResourceType: AWS::EC2::Instance
      SecurityServicePolicyData:
        Type: SECURITY_GROUPS_COMMON
        ManagedServiceData: !Sub '{"type":"SECURITY_GROUPS_COMMON",
                                  "revertManualSecurityGroupChanges":true,
                                  "securityGroups":[{"id":"${SecurityGroup.GroupId}"}]}'

JSON

"Policy": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": false,
        "PolicyName": "SecurityGroupsCommonsPolicy",
        "RemediationEnabled": false,
        "ResourceType": "AWS::EC2::Instance",
        "SecurityServicePolicyData": {
            "Type": "SECURITY_GROUPS_COMMON",
            "ManagedServiceData": {
                "Fn::Sub": "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":true,\"securityGroups\":[{\"id\":\"${SecurityGroup.GroupId}\"}]}"
            }
        }
    }
}

Create a Firewall Manager content audit security group policy

The following shows an example Firewall Manager usage audit security group policy.

YAML

PolicySGContentAudit:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: Policy
      RemediationEnabled: false
      ResourceType: AWS::EC2::Instance
      SecurityServicePolicyData:
        Type: SECURITY_GROUPS_CONTENT_AUDIT
        ManagedServiceData: !Sub '{"type":"SECURITY_GROUPS_CONTENT_AUDIT",
                                  "securityGroupAction":{"type":"ALLOW"},
                                  "securityGroups":[
                                    {"id":"${SecurityGroup.GroupId}"}
                                  ]}'

JSON

"PolicySGContentAudit": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
            "ExcludeResourceTags": false,
            "PolicyName": "Policy",
            "RemediationEnabled": false,
            "ResourceType": "AWS::EC2::Instance",
            "SecurityServicePolicyData": {
                "Type": "SECURITY_GROUPS_CONTENT_AUDIT",
                "ManagedServiceData": {
                    "Fn::Sub": "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroupAction\":{\"type\":\"ALLOW\"},\"securityGroups\":[{\"id\":\"${SecurityGroup.GroupId}\"}]}"
                }
            }
        }
    }

Create a Firewall Manager usage audit security group policy

The following shows an example Firewall Manager usage audit security group policy.

YAML

PolicySGUsageAudit:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: Policy
      RemediationEnabled: false
      ResourceType: AWS::EC2::SecurityGroup
      SecurityServicePolicyData:
        Type: SECURITY_GROUPS_USAGE_AUDIT
        ManagedServiceData: !Sub '{"type":"SECURITY_GROUPS_USAGE_AUDIT",
                                  "deleteUnusedSecurityGroups":false,
                                  "coalesceRedundantSecurityGroups":false,
                                  "optionalDelayForUnusedInMinutes":null}'

JSON

"PolicySGUsageAudit": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": false,
        "PolicyName": "PolicySGUsageAudit",
        "RemediationEnabled": false,
        "ResourceType": "AWS::EC2::SecurityGroup",
        "SecurityServicePolicyData": {
            "Type": "SECURITY_GROUPS_USAGE_AUDIT",
            "ManagedServiceData": {
                "Fn::Sub": "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":false,\"coalesceRedundantSecurityGroups\":false,\"optionalDelayForUnusedInMinutes\":null}"
            }
        }
    }
}

Create a Firewall Manager Network Firewall policy

The following shows an example Firewall Manager Network Firewall policy.

YAML

PolicyNetworkFirewall:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: PolicyNetworkFirewall
      RemediationEnabled: true
      ResourceType: AWS::EC2::VPC
      DeleteAllPolicyResources: true
      SecurityServicePolicyData:
        Type: NETWORK_FIREWALL
        ManagedServiceData: '
          {
            "type": "NETWORK_FIREWALL",
            "networkFirewallStatelessRuleGroupReferences": [
              {
                "resourceARN": "arn:aws:network-firewall:us-east-1:000000000000:stateless-rulegroup/example",
                "priority": 1
              }
            ],
            "networkFirewallStatelessDefaultActions": [
              "aws:drop",
              "example"
            ],
            "networkFirewallStatelessFragmentDefaultActions": [
              "aws:drop",
              "example"
            ],
            "networkFirewallStatelessCustomActions": [
              {
                "actionName": "example",
                "actionDefinition": {
                  "publishMetricAction": {
                    "dimensions": [
                      {
                        "value": "example"
                      }
                    ]
                  }
                }
              }
            ],
            "networkFirewallStatefulRuleGroupReferences": [
              {
                "resourceARN": "arn:aws:network-firewall:us-east-1:000000000000:stateful-rulegroup/example"
              }
            ],
            "networkFirewallOrchestrationConfig": {
              "singleFirewallEndpointPerVPC": false,
              "allowedIPV4CidrList": []
            }
          }'

JSON

"PolicyNetworkFirewall": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": false,
        "PolicyName": "PolicyNetworkFirewall",
        "RemediationEnabled": true,
        "ResourceType": "AWS::EC2::VPC",
        "DeleteAllPolicyResources": true,
        "SecurityServicePolicyData": {
            "Type": "NETWORK_FIREWALL",
            "ManagedServiceData": "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:000000000000:stateless-rulegroup\/example\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:drop\",\"example\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:drop\",\"example\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"example\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"example\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:000000000000:stateful-rulegroup\/example\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[]}}"
        }
    }
}

Create a Firewall Manager DNS Firewall policy

The following shows an example Firewall Manager DNS Firewall policy.

YAML

Policy:
    Type: AWS::FMS::Policy
    Properties:
      ExcludeResourceTags: false
      PolicyName: DnsFirewallPolicy
      RemediationEnabled: false
      ResourceType: AWS::EC2::VPC
      SecurityServicePolicyData:
        Type: DNS_FIREWALL
        ManagedServiceData: !Sub '{"type":"DNS_FIREWALL",
                                  "preProcessRuleGroups":[{"ruleGroupId": "${PreRuleGroupId}", "priority": 11}],
                                  "postProcessRuleGroups":[{"ruleGroupId": "${PostRuleGroupId}", "priority": 9902}]}'

JSON

"Policy": {
    "Type": "AWS::FMS::Policy",
    "Properties": {
        "ExcludeResourceTags": false,
        "PolicyName": "DnsFirewallPolicy",
        "RemediationEnabled": false,
        "ResourceType": "AWS::EC2::VPC",
        "SecurityServicePolicyData": {
            "Type": "DNS_FIREWALL",
            "ManagedServiceData": {
                "Fn::Sub": "{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\": \"${PreRuleGroupId}\", \"priority\": 11}],\"postProcessRuleGroups\":[{\"ruleGroupId\": \"${PostRuleGroupId}\", \"priority\": 9902}]}"
            }
        }
    }
}