This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::NetworkFirewall::FirewallPolicy
<a name="aws-resource-networkfirewall-firewallpolicy"></a>

Use the firewall policy to define the stateless and stateful network traffic filtering behavior for your firewall. You can use one firewall policy for multiple firewalls. 

## Syntax
<a name="aws-resource-networkfirewall-firewallpolicy-syntax"></a>

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

### JSON
<a name="aws-resource-networkfirewall-firewallpolicy-syntax.json"></a>

```
{
  "Type" : "AWS::NetworkFirewall::FirewallPolicy",
  "Properties" : {
      "[Description](#cfn-networkfirewall-firewallpolicy-description)" : String,
      "[FirewallPolicy](#cfn-networkfirewall-firewallpolicy-firewallpolicy)" : FirewallPolicy,
      "[FirewallPolicyName](#cfn-networkfirewall-firewallpolicy-firewallpolicyname)" : String,
      "[Tags](#cfn-networkfirewall-firewallpolicy-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-networkfirewall-firewallpolicy-syntax.yaml"></a>

```
Type: AWS::NetworkFirewall::FirewallPolicy
Properties:
  [Description](#cfn-networkfirewall-firewallpolicy-description): String
  [FirewallPolicy](#cfn-networkfirewall-firewallpolicy-firewallpolicy): 
    FirewallPolicy
  [FirewallPolicyName](#cfn-networkfirewall-firewallpolicy-firewallpolicyname): String
  [Tags](#cfn-networkfirewall-firewallpolicy-tags): 
    - Tag
```

## Properties
<a name="aws-resource-networkfirewall-firewallpolicy-properties"></a>

`Description`  <a name="cfn-networkfirewall-firewallpolicy-description"></a>
A description of the firewall policy.  
*Required*: No  
*Type*: String  
*Pattern*: `^.*$`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FirewallPolicy`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy"></a>
The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.   
*Required*: Yes  
*Type*: [FirewallPolicy](aws-properties-networkfirewall-firewallpolicy-firewallpolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FirewallPolicyName`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicyname"></a>
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-networkfirewall-firewallpolicy-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-networkfirewall-firewallpolicy-tag.md)  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-networkfirewall-firewallpolicy-return-values"></a>

### Ref
<a name="aws-resource-networkfirewall-firewallpolicy-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the firewall policy. For example: 

 `{ "Ref": "arn:aws:network-firewall:us-east-1:012345678901:firewall-policy/myFirewallPolicyName" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-networkfirewall-firewallpolicy-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-networkfirewall-firewallpolicy-return-values-fn--getatt-fn--getatt"></a>

`FirewallPolicyArn`  <a name="FirewallPolicyArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the firewall policy. 

`FirewallPolicyId`  <a name="FirewallPolicyId-fn::getatt"></a>
The unique ID of the firewall policy resource. 

## Examples
<a name="aws-resource-networkfirewall-firewallpolicy--examples"></a>



### Create a firewall policy
<a name="aws-resource-networkfirewall-firewallpolicy--examples--Create_a_firewall_policy"></a>

The following shows example firewall policy specifications. 

#### JSON
<a name="aws-resource-networkfirewall-firewallpolicy--examples--Create_a_firewall_policy--json"></a>

```
"SampleFirewallPolicy": {
    "Type": "AWS::NetworkFirewall::FirewallPolicy",
    "Properties": {
        "FirewallPolicyName": "SampleFirewallPolicyName",
        "FirewallPolicy": {
            "StatelessDefaultActions": [
                "aws:pass"
            ],
            "StatelessFragmentDefaultActions": [
                "aws:drop"
            ],
            "StatefulRuleGroupReferences": [
                {
                    "ResourceArn": {
                        "Ref": "SampleStatefulRuleGroup"
                    }
                }
            ],
            "StatelessRuleGroupReferences": [
                {
                    "ResourceArn": {
                        "Ref": "SampleStatelessRuleGroup"
                    },
                    "Priority": 100
                }
            ]
        },
        "Description": "FirewallPolicy description goes here",
        "Tags": [
            {
                "Key": "Foo",
                "Value": "Bar"
            }
        ]
    }
}
```

#### YAML
<a name="aws-resource-networkfirewall-firewallpolicy--examples--Create_a_firewall_policy--yaml"></a>

```
SampleFirewallPolicy:
  Type: 'AWS::NetworkFirewall::FirewallPolicy'
  Properties:
    FirewallPolicyName: SampleFirewallPolicyName
    FirewallPolicy:
      StatelessDefaultActions:
        - 'aws:pass'
      StatelessFragmentDefaultActions:
        - 'aws:drop'
      StatefulRuleGroupReferences:
        - ResourceArn: !Ref SampleStatefulRuleGroup1
      StatelessRuleGroupReferences:
        - ResourceArn: !Ref SampleStatelessRuleGroup
          Priority: 100
    Description: FirewallPolicy description goes here
    Tags:
      - Key: Foo
        Value: Bar
```

# AWS::NetworkFirewall::FirewallPolicy ActionDefinition
<a name="aws-properties-networkfirewall-firewallpolicy-actiondefinition"></a>

A custom action to use in stateless rule actions settings. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-actiondefinition-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-actiondefinition-syntax.json"></a>

```
{
  "[PublishMetricAction](#cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction)" : PublishMetricAction
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-actiondefinition-syntax.yaml"></a>

```
  [PublishMetricAction](#cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction): 
    PublishMetricAction
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-actiondefinition-properties"></a>

`PublishMetricAction`  <a name="cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction"></a>
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.  
You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.   
*Required*: No  
*Type*: [PublishMetricAction](aws-properties-networkfirewall-firewallpolicy-publishmetricaction.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy CustomAction
<a name="aws-properties-networkfirewall-firewallpolicy-customaction"></a>

An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify. 

You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings. 

You can use custom actions in the following places: 
+ In an `StatelessRulesAndCustomActions`. The custom actions are available for use by name inside the `StatelessRulesAndCustomActions` where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes. 
+ In an firewall policy specification, in `StatelessCustomActions`. The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-customaction-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-customaction-syntax.json"></a>

```
{
  "[ActionDefinition](#cfn-networkfirewall-firewallpolicy-customaction-actiondefinition)" : ActionDefinition,
  "[ActionName](#cfn-networkfirewall-firewallpolicy-customaction-actionname)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-customaction-syntax.yaml"></a>

```
  [ActionDefinition](#cfn-networkfirewall-firewallpolicy-customaction-actiondefinition): 
    ActionDefinition
  [ActionName](#cfn-networkfirewall-firewallpolicy-customaction-actionname): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-customaction-properties"></a>

`ActionDefinition`  <a name="cfn-networkfirewall-firewallpolicy-customaction-actiondefinition"></a>
The custom action associated with the action name.  
*Required*: Yes  
*Type*: [ActionDefinition](aws-properties-networkfirewall-firewallpolicy-actiondefinition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ActionName`  <a name="cfn-networkfirewall-firewallpolicy-customaction-actionname"></a>
The descriptive name of the custom action. You can't change the name of a custom action after you create it.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy Dimension
<a name="aws-properties-networkfirewall-firewallpolicy-dimension"></a>

The value to use in an Amazon CloudWatch custom metric dimension. This is used in the `PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric. 

AWS Network Firewall sets the dimension name to `CustomAction` and you provide the dimension value. 

For more information about CloudWatch custom metric dimensions, see [Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-dimension-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-dimension-syntax.json"></a>

```
{
  "[Value](#cfn-networkfirewall-firewallpolicy-dimension-value)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-dimension-syntax.yaml"></a>

```
  [Value](#cfn-networkfirewall-firewallpolicy-dimension-value): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-dimension-properties"></a>

`Value`  <a name="cfn-networkfirewall-firewallpolicy-dimension-value"></a>
The value to use in the custom metric dimension.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_ ]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy FirewallPolicy
<a name="aws-properties-networkfirewall-firewallpolicy-firewallpolicy"></a>

The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-firewallpolicy-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-firewallpolicy-syntax.json"></a>

```
{
  "[EnableTLSSessionHolding](#cfn-networkfirewall-firewallpolicy-firewallpolicy-enabletlssessionholding)" : Boolean,
  "[PolicyVariables](#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables)" : PolicyVariables,
  "[StatefulDefaultActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions)" : [ String, ... ],
  "[StatefulEngineOptions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions)" : StatefulEngineOptions,
  "[StatefulRuleGroupReferences](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences)" : [ StatefulRuleGroupReference, ... ],
  "[StatelessCustomActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions)" : [ CustomAction, ... ],
  "[StatelessDefaultActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions)" : [ String, ... ],
  "[StatelessFragmentDefaultActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions)" : [ String, ... ],
  "[StatelessRuleGroupReferences](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences)" : [ StatelessRuleGroupReference, ... ],
  "[TLSInspectionConfigurationArn](#cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-firewallpolicy-syntax.yaml"></a>

```
  [EnableTLSSessionHolding](#cfn-networkfirewall-firewallpolicy-firewallpolicy-enabletlssessionholding): Boolean
  [PolicyVariables](#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables): 
    PolicyVariables
  [StatefulDefaultActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions): 
    - String
  [StatefulEngineOptions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions): 
    StatefulEngineOptions
  [StatefulRuleGroupReferences](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences): 
    - StatefulRuleGroupReference
  [StatelessCustomActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions): 
    - CustomAction
  [StatelessDefaultActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions): 
    - String
  [StatelessFragmentDefaultActions](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions): 
    - String
  [StatelessRuleGroupReferences](#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences): 
    - StatelessRuleGroupReference
  [TLSInspectionConfigurationArn](#cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-firewallpolicy-properties"></a>

`EnableTLSSessionHolding`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-enabletlssessionholding"></a>
When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PolicyVariables`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables"></a>
Contains variables that you can use to override default Suricata settings in your firewall policy.  
*Required*: No  
*Type*: [PolicyVariables](aws-properties-networkfirewall-firewallpolicy-policyvariables.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatefulDefaultActions`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions"></a>
The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.  
Valid values of the stateful default action:  
+ aws:drop\$1strict
+ aws:drop\$1established
+ aws:alert\$1strict
+ aws:alert\$1established
For more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide*.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatefulEngineOptions`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions"></a>
Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.  
*Required*: No  
*Type*: [StatefulEngineOptions](aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatefulRuleGroupReferences`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences"></a>
References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.   
*Required*: No  
*Type*: Array of [StatefulRuleGroupReference](aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatelessCustomActions`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions"></a>
The custom action definitions that are available for use in the firewall policy's `StatelessDefaultActions` setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.  
*Required*: No  
*Type*: Array of [CustomAction](aws-properties-networkfirewall-firewallpolicy-customaction.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatelessDefaultActions`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions"></a>
The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe`.   
You must specify one of the standard actions: `aws:pass`, `aws:drop`, or `aws:forward_to_sfe`. In addition, you can specify custom actions that are compatible with your standard section choice.  
For example, you could specify `["aws:pass"]` or you could specify `["aws:pass", “customActionName”]`. For information about compatibility, see the custom action descriptions.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatelessFragmentDefaultActions`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions"></a>
The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy. If you want non-matching fragmented packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe`.   
You must specify one of the standard actions: `aws:pass`, `aws:drop`, or `aws:forward_to_sfe`. In addition, you can specify custom actions that are compatible with your standard section choice.  
For example, you could specify `["aws:pass"]` or you could specify `["aws:pass", “customActionName”]`. For information about compatibility, see the custom action descriptions.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatelessRuleGroupReferences`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences"></a>
References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.   
*Required*: No  
*Type*: Array of [StatelessRuleGroupReference](aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TLSInspectionConfigurationArn`  <a name="cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn"></a>
The Amazon Resource Name (ARN) of the TLS inspection configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^(arn:aws.*)$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy FlowTimeouts
<a name="aws-properties-networkfirewall-firewallpolicy-flowtimeouts"></a>

Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. When you update this value, existing connections will be treated according to your stream exception policy configuration. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-flowtimeouts-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-flowtimeouts-syntax.json"></a>

```
{
  "[TcpIdleTimeoutSeconds](#cfn-networkfirewall-firewallpolicy-flowtimeouts-tcpidletimeoutseconds)" : Integer
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-flowtimeouts-syntax.yaml"></a>

```
  [TcpIdleTimeoutSeconds](#cfn-networkfirewall-firewallpolicy-flowtimeouts-tcpidletimeoutseconds): Integer
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-flowtimeouts-properties"></a>

`TcpIdleTimeoutSeconds`  <a name="cfn-networkfirewall-firewallpolicy-flowtimeouts-tcpidletimeoutseconds"></a>
The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout.   
You can define the `TcpIdleTimeoutSeconds` value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.   
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `6000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy IPSet
<a name="aws-properties-networkfirewall-firewallpolicy-ipset"></a>

A list of IP addresses and address ranges, in CIDR notation. This is part of a rule variable. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-ipset-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-ipset-syntax.json"></a>

```
{
  "[Definition](#cfn-networkfirewall-firewallpolicy-ipset-definition)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-ipset-syntax.yaml"></a>

```
  [Definition](#cfn-networkfirewall-firewallpolicy-ipset-definition): 
    - String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-ipset-properties"></a>

`Definition`  <a name="cfn-networkfirewall-firewallpolicy-ipset-definition"></a>
The list of IP addresses and address ranges, in CIDR notation.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy PolicyVariables
<a name="aws-properties-networkfirewall-firewallpolicy-policyvariables"></a>

Contains variables that you can use to override default Suricata settings in your firewall policy.

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-policyvariables-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-policyvariables-syntax.json"></a>

```
{
  "[RuleVariables](#cfn-networkfirewall-firewallpolicy-policyvariables-rulevariables)" : {Key: Value, ...}
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-policyvariables-syntax.yaml"></a>

```
  [RuleVariables](#cfn-networkfirewall-firewallpolicy-policyvariables-rulevariables): 
    Key: Value
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-policyvariables-properties"></a>

`RuleVariables`  <a name="cfn-networkfirewall-firewallpolicy-policyvariables-rulevariables"></a>
The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata `HOME_NET` variable. If your firewall uses an inspection VPC, you might want to override the `HOME_NET` variable with the CIDRs of your home networks. If you don't override `HOME_NET` with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.  
*Required*: No  
*Type*: Object of [IPSet](aws-properties-networkfirewall-firewallpolicy-ipset.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy PublishMetricAction
<a name="aws-properties-networkfirewall-firewallpolicy-publishmetricaction"></a>

Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-publishmetricaction-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-publishmetricaction-syntax.json"></a>

```
{
  "[Dimensions](#cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions)" : [ Dimension, ... ]
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-publishmetricaction-syntax.yaml"></a>

```
  [Dimensions](#cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions): 
    - Dimension
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-publishmetricaction-properties"></a>

`Dimensions`  <a name="cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions"></a>
  
*Required*: Yes  
*Type*: Array of [Dimension](aws-properties-networkfirewall-firewallpolicy-dimension.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy StatefulEngineOptions
<a name="aws-properties-networkfirewall-firewallpolicy-statefulengineoptions"></a>

Configuration settings for the handling of the stateful rule groups in a firewall policy. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-statefulengineoptions-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-statefulengineoptions-syntax.json"></a>

```
{
  "[FlowTimeouts](#cfn-networkfirewall-firewallpolicy-statefulengineoptions-flowtimeouts)" : FlowTimeouts,
  "[RuleOrder](#cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder)" : String,
  "[StreamExceptionPolicy](#cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-statefulengineoptions-syntax.yaml"></a>

```
  [FlowTimeouts](#cfn-networkfirewall-firewallpolicy-statefulengineoptions-flowtimeouts): 
    FlowTimeouts
  [RuleOrder](#cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder): String
  [StreamExceptionPolicy](#cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-statefulengineoptions-properties"></a>

`FlowTimeouts`  <a name="cfn-networkfirewall-firewallpolicy-statefulengineoptions-flowtimeouts"></a>
Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.   
*Required*: No  
*Type*: [FlowTimeouts](aws-properties-networkfirewall-firewallpolicy-flowtimeouts.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RuleOrder`  <a name="cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder"></a>
Indicates how to manage the order of stateful rule evaluation for the policy. `DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide*.   
*Required*: No  
*Type*: String  
*Allowed values*: `DEFAULT_ACTION_ORDER | STRICT_ORDER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamExceptionPolicy`  <a name="cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy"></a>
Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.  
+ `DROP` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
+ `CONTINUE` - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action.
+ `REJECT` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
*Required*: No  
*Type*: String  
*Allowed values*: `DROP | CONTINUE | REJECT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy StatefulRuleGroupOverride
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride"></a>

The setting that allows the policy owner to change the behavior of the rule group within a policy. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride-syntax.json"></a>

```
{
  "[Action](#cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride-syntax.yaml"></a>

```
  [Action](#cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride-properties"></a>

`Action`  <a name="cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action"></a>
The action that changes the rule group from `DROP` to `ALERT`. This only applies to managed rule groups.  
*Required*: No  
*Type*: String  
*Allowed values*: `DROP_TO_ALERT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy StatefulRuleGroupReference
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference"></a>

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference-syntax.json"></a>

```
{
  "[DeepThreatInspection](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-deepthreatinspection)" : Boolean,
  "[Override](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override)" : StatefulRuleGroupOverride,
  "[Priority](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority)" : Integer,
  "[ResourceArn](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference-syntax.yaml"></a>

```
  [DeepThreatInspection](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-deepthreatinspection): Boolean
  [Override](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override): 
    StatefulRuleGroupOverride
  [Priority](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority): Integer
  [ResourceArn](#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference-properties"></a>

`DeepThreatInspection`  <a name="cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-deepthreatinspection"></a>
AWS Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability. When this capability is released, AWS will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. AWS will use these threat indicators to improve the active threat defense managed rule groups and protect the security of AWS customers and services.  
Customers can opt-out of deep threat inspection at any time through the AWS Network Firewall console or API. When customers opt out, AWS Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement.
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Override`  <a name="cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override"></a>
The action that allows the policy owner to override the behavior of the rule group within a policy.  
*Required*: No  
*Type*: [StatefulRuleGroupOverride](aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Priority`  <a name="cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority"></a>
An integer setting that indicates the order in which to run the stateful rule groups in a single firewall policy. This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings.  
Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.  
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.   
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `65535`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceArn`  <a name="cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn"></a>
The Amazon Resource Name (ARN) of the stateful rule group.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(arn:aws.*)$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy StatelessRuleGroupReference
<a name="aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference"></a>

Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference-syntax.json"></a>

```
{
  "[Priority](#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority)" : Integer,
  "[ResourceArn](#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference-syntax.yaml"></a>

```
  [Priority](#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority): Integer
  [ResourceArn](#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference-properties"></a>

`Priority`  <a name="cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority"></a>
An integer setting that indicates the order in which to run the stateless rule groups in a single firewall policy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `65535`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceArn`  <a name="cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn"></a>
The Amazon Resource Name (ARN) of the stateless rule group.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(arn:aws.*)$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkFirewall::FirewallPolicy Tag
<a name="aws-properties-networkfirewall-firewallpolicy-tag"></a>

A key:value pair 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. 

## Syntax
<a name="aws-properties-networkfirewall-firewallpolicy-tag-syntax"></a>

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

### JSON
<a name="aws-properties-networkfirewall-firewallpolicy-tag-syntax.json"></a>

```
{
  "[Key](#cfn-networkfirewall-firewallpolicy-tag-key)" : String,
  "[Value](#cfn-networkfirewall-firewallpolicy-tag-value)" : String
}
```

### YAML
<a name="aws-properties-networkfirewall-firewallpolicy-tag-syntax.yaml"></a>

```
  [Key](#cfn-networkfirewall-firewallpolicy-tag-key): String
  [Value](#cfn-networkfirewall-firewallpolicy-tag-value): String
```

## Properties
<a name="aws-properties-networkfirewall-firewallpolicy-tag-properties"></a>

`Key`  <a name="cfn-networkfirewall-firewallpolicy-tag-key"></a>
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^.*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-networkfirewall-firewallpolicy-tag-value"></a>
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^.*$`  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)