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::WAFv2::LoggingConfiguration
<a name="aws-resource-wafv2-loggingconfiguration"></a>

Defines an association between logging destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records. 

If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs. 

**Note**  
You can define one logging destination per web ACL.

You can access information about the traffic that AWS WAF inspects using the following steps:

1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. 

   The name that you give the destination must start with `aws-waf-logs-`. Depending on the type of destination, you might need to configure additional settings or permissions. 

   For configuration requirements and pricing information for each destination type, see [Logging web ACL traffic](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the *AWS WAF Developer Guide*.

1. Associate your logging destination to your web ACL using a `PutLoggingConfiguration` request.

When you successfully enable logging using a `PutLoggingConfiguration` request, AWS WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, AWS WAF creates a resource policy on the log group. For an Amazon S3 bucket, AWS WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, AWS WAF creates a service-linked role.

For additional information about web ACL logging, see [Logging web ACL traffic information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the *AWS WAF Developer Guide*.

## Syntax
<a name="aws-resource-wafv2-loggingconfiguration-syntax"></a>

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

### JSON
<a name="aws-resource-wafv2-loggingconfiguration-syntax.json"></a>

```
{
  "Type" : "AWS::WAFv2::LoggingConfiguration",
  "Properties" : {
      "[LogDestinationConfigs](#cfn-wafv2-loggingconfiguration-logdestinationconfigs)" : [ String, ... ],
      "[LoggingFilter](#cfn-wafv2-loggingconfiguration-loggingfilter)" : LoggingFilter,
      "[RedactedFields](#cfn-wafv2-loggingconfiguration-redactedfields)" : [ FieldToMatch, ... ],
      "[ResourceArn](#cfn-wafv2-loggingconfiguration-resourcearn)" : String
    }
}
```

### YAML
<a name="aws-resource-wafv2-loggingconfiguration-syntax.yaml"></a>

```
Type: AWS::WAFv2::LoggingConfiguration
Properties:
  [LogDestinationConfigs](#cfn-wafv2-loggingconfiguration-logdestinationconfigs): 
    - String
  [LoggingFilter](#cfn-wafv2-loggingconfiguration-loggingfilter): 
    LoggingFilter
  [RedactedFields](#cfn-wafv2-loggingconfiguration-redactedfields): 
    - FieldToMatch
  [ResourceArn](#cfn-wafv2-loggingconfiguration-resourcearn): String
```

## Properties
<a name="aws-resource-wafv2-loggingconfiguration-properties"></a>

`LogDestinationConfigs`  <a name="cfn-wafv2-loggingconfiguration-logdestinationconfigs"></a>
The logging destination configuration that you want to associate with the web ACL.  
You can associate one logging destination to a web ACL.
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoggingFilter`  <a name="cfn-wafv2-loggingconfiguration-loggingfilter"></a>
Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.   
*Required*: No  
*Type*: [LoggingFilter](aws-properties-wafv2-loggingconfiguration-loggingfilter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RedactedFields`  <a name="cfn-wafv2-loggingconfiguration-redactedfields"></a>
The parts of the request that you want to keep out of the logs.  
For example, if you redact the `SingleHeader` field, the `HEADER` field in the logs will be `REDACTED` for all rules that use the `SingleHeader``FieldToMatch` setting.   
If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.   
Redaction applies only to the component that's specified in the rule's `FieldToMatch` setting, so the `SingleHeader` redaction doesn't apply to rules that use the `Headers``FieldToMatch`.  
You can specify only the following fields for redaction: `UriPath`, `QueryString`, `SingleHeader`, and `Method`.
This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.
*Required*: No  
*Type*: Array of [FieldToMatch](aws-properties-wafv2-loggingconfiguration-fieldtomatch.md)  
*Maximum*: `100`  
*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-wafv2-loggingconfiguration-resourcearn"></a>
The Amazon Resource Name (ARN) of the web ACL that you want to associate with `LogDestinationConfigs`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.*\S.*`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-wafv2-loggingconfiguration-return-values"></a>

### Ref
<a name="aws-resource-wafv2-loggingconfiguration-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 web ACL. 

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-wafv2-loggingconfiguration-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-wafv2-loggingconfiguration-return-values-fn--getatt-fn--getatt"></a>

`ManagedByFirewallManager`  <a name="ManagedByFirewallManager-fn::getatt"></a>
Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. 

## Examples
<a name="aws-resource-wafv2-loggingconfiguration--examples"></a>



**Topics**
+ [Create a logging configuration with redacted fields](#aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_redacted_fields)
+ [Create a logging configuration with a filter](#aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_a_filter)

### Create a logging configuration with redacted fields
<a name="aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_redacted_fields"></a>

The following shows an example logging configuration with redacted fields. 

#### YAML
<a name="aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_redacted_fields--yaml"></a>

```
  LoggingConfiguration:
    Type: AWS::WAFv2::LoggingConfiguration
    Properties:
      ResourceArn: arn:aws:wafv2:us-east-1:123456789000:regional/webacl/test-webaclv2/abcd1234-123b-1234-1234-123456789abc
      LogDestinationConfigs:
      - arn:aws:firehose:us-east-1:123456789000:deliverystream/aws-waf-logs-firehose
      RedactedFields:
      - Method: {}
      - QueryString: {}
      - SingleHeader:
          Name: password
      - UriPath: {}
```

#### JSON
<a name="aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_redacted_fields--json"></a>

```
  "LoggingConfiguration": {
    "Type": "AWS::WAFv2::LoggingConfiguration",
    "Properties": {
      "ResourceArn": "arn:aws:wafv2:us-east-1:123456789000:regional/webacl/test-webaclv2/abcd1234-123b-1234-1234-123456789abc",
      "LogDestinationConfigs": [
        "arn:aws:firehose:us-east-1:123456789000:deliverystream/aws-waf-logs-firehose"
      ],
      "RedactedFields": [
      {
        "Method": {}
      },
      {
        "QueryString": {}
      },
      {
        "SingleHeader": {
          "Name": "password"
        }
      },
      {
        "UriPath": {}
      } ]
    }
  }
```

### Create a logging configuration with a filter
<a name="aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_a_filter"></a>

The following shows an example logging configuration with a logging filter. 

#### YAML
<a name="aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_a_filter--yaml"></a>

```
  LoggingConfiguration:
    Type: AWS::WAFv2::LoggingConfiguration
    Properties:
      ResourceArn: arn:aws:wafv2:us-east-1:123456789000:regional/webacl/test-webaclv2/abcd1234-123b-1234-1234-123456789abc
      LogDestinationConfigs:
      - arn:aws:firehose:us-east-1:123456789000:deliverystream/aws-waf-logs-firehose
      RedactedFields:
      - Method: {}
      - QueryString: {}
      - SingleHeader:
          Name: password
      - UriPath: {}
      LoggingFilter:
        DefaultBehavior: KEEP
        Filters:
        - Behavior: KEEP
          Conditions:
          - ActionCondition:
              Action: BLOCK
          - LabelNameCondition:
              LabelName: fooLabel
          Requirement: MEETS_ANY
```

#### JSON
<a name="aws-resource-wafv2-loggingconfiguration--examples--Create_a_logging_configuration_with_a_filter--json"></a>

```
  "LoggingConfiguration": {
      "Type": "AWS::WAFv2::LoggingConfiguration",
      "Properties": {
        "ResourceArn": "arn:aws:wafv2:us-east-1:123456789000:regional/webacl/test-webaclv2/abcd1234-123b-1234-1234-123456789abc",
        "LogDestinationConfigs": [
          "arn:aws:firehose:us-east-1:123456789000:deliverystream/aws-waf-logs-firehose"
        ],
        "RedactedFields": [
          {
            "Method": {}
          },
          {
            "QueryString": {}
          },
          {
            "SingleHeader": {
              "Name": "password"
            }
          },
          {
            "UriPath": {}
          }
        ],
        "LoggingFilter": {
          "DefaultBehavior": "KEEP",
          "Filters": [
            {
              "Behavior": "KEEP",
              "Conditions": [
                {
                  "ActionCondition": {
                    "Action": "BLOCK"
                  }
                },
                {
                  "LabelNameCondition": {
                    "LabelName": "fooLabel"
                  }
                }
              ],
              "Requirement": "MEETS_ANY"
            }
          ]
        }
      }
    }
```

# AWS::WAFv2::LoggingConfiguration ActionCondition
<a name="aws-properties-wafv2-loggingconfiguration-actioncondition"></a>

A single action condition for a condition in a logging filter.

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-actioncondition-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-actioncondition-syntax.json"></a>

```
{
  "[Action](#cfn-wafv2-loggingconfiguration-actioncondition-action)" : String
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-actioncondition-syntax.yaml"></a>

```
  [Action](#cfn-wafv2-loggingconfiguration-actioncondition-action): String
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-actioncondition-properties"></a>

`Action`  <a name="cfn-wafv2-loggingconfiguration-actioncondition-action"></a>
The action setting that a log record must contain in order to meet the condition. This is the action that AWS WAF applied to the web request.   
For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value `EXCLUDED_AS_COUNT` matches on excluded rules and also on rules that have a rule action override of Count.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `ALLOW | BLOCK | COUNT | CAPTCHA | CHALLENGE | EXCLUDED_AS_COUNT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WAFv2::LoggingConfiguration Condition
<a name="aws-properties-wafv2-loggingconfiguration-condition"></a>

A single match condition for a log filter.

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-condition-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-condition-syntax.json"></a>

```
{
  "[ActionCondition](#cfn-wafv2-loggingconfiguration-condition-actioncondition)" : ActionCondition,
  "[LabelNameCondition](#cfn-wafv2-loggingconfiguration-condition-labelnamecondition)" : LabelNameCondition
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-condition-syntax.yaml"></a>

```
  [ActionCondition](#cfn-wafv2-loggingconfiguration-condition-actioncondition): 
    ActionCondition
  [LabelNameCondition](#cfn-wafv2-loggingconfiguration-condition-labelnamecondition): 
    LabelNameCondition
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-condition-properties"></a>

`ActionCondition`  <a name="cfn-wafv2-loggingconfiguration-condition-actioncondition"></a>
A single action condition. This is the action setting that a log record must contain in order to meet the condition.  
*Required*: No  
*Type*: [ActionCondition](aws-properties-wafv2-loggingconfiguration-actioncondition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LabelNameCondition`  <a name="cfn-wafv2-loggingconfiguration-condition-labelnamecondition"></a>
A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.   
*Required*: No  
*Type*: [LabelNameCondition](aws-properties-wafv2-loggingconfiguration-labelnamecondition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WAFv2::LoggingConfiguration FieldToMatch
<a name="aws-properties-wafv2-loggingconfiguration-fieldtomatch"></a>

The parts of the request that you want to keep out of the logs. This is used in the logging configuration `RedactedFields` specification. 

Example JSON for a `QueryString` field to match: 

 ` "FieldToMatch": { "QueryString": {} }` 

Example JSON for a `Method` field to match specification:

 ` "FieldToMatch": { "Method": { "Name": "DELETE" } }` 

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-fieldtomatch-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-fieldtomatch-syntax.json"></a>

```
{
  "[Method](#cfn-wafv2-loggingconfiguration-fieldtomatch-method)" : Json,
  "[QueryString](#cfn-wafv2-loggingconfiguration-fieldtomatch-querystring)" : Json,
  "[SingleHeader](#cfn-wafv2-loggingconfiguration-fieldtomatch-singleheader)" : SingleHeader,
  "[UriPath](#cfn-wafv2-loggingconfiguration-fieldtomatch-uripath)" : Json
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-fieldtomatch-syntax.yaml"></a>

```
  [Method](#cfn-wafv2-loggingconfiguration-fieldtomatch-method): Json
  [QueryString](#cfn-wafv2-loggingconfiguration-fieldtomatch-querystring): Json
  [SingleHeader](#cfn-wafv2-loggingconfiguration-fieldtomatch-singleheader): 
    SingleHeader
  [UriPath](#cfn-wafv2-loggingconfiguration-fieldtomatch-uripath): Json
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-fieldtomatch-properties"></a>

`Method`  <a name="cfn-wafv2-loggingconfiguration-fieldtomatch-method"></a>
Redact the indicated HTTP method. The method indicates the type of operation that the request is asking the origin to perform.   
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryString`  <a name="cfn-wafv2-loggingconfiguration-fieldtomatch-querystring"></a>
Redact the query string. This is the part of a URL that appears after a `?` character, if any.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SingleHeader`  <a name="cfn-wafv2-loggingconfiguration-fieldtomatch-singleheader"></a>
Redact a single header. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`. This setting isn't case sensitive.  
Example JSON: `"SingleHeader": { "Name": "haystack" }`  
*Required*: No  
*Type*: [SingleHeader](aws-properties-wafv2-loggingconfiguration-singleheader.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UriPath`  <a name="cfn-wafv2-loggingconfiguration-fieldtomatch-uripath"></a>
Redact the request URI path. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WAFv2::LoggingConfiguration Filter
<a name="aws-properties-wafv2-loggingconfiguration-filter"></a>

A single logging filter, used in `LoggingFilter`. 

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-filter-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-filter-syntax.json"></a>

```
{
  "[Behavior](#cfn-wafv2-loggingconfiguration-filter-behavior)" : String,
  "[Conditions](#cfn-wafv2-loggingconfiguration-filter-conditions)" : [ Condition, ... ],
  "[Requirement](#cfn-wafv2-loggingconfiguration-filter-requirement)" : String
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-filter-syntax.yaml"></a>

```
  [Behavior](#cfn-wafv2-loggingconfiguration-filter-behavior): String
  [Conditions](#cfn-wafv2-loggingconfiguration-filter-conditions): 
    - Condition
  [Requirement](#cfn-wafv2-loggingconfiguration-filter-requirement): String
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-filter-properties"></a>

`Behavior`  <a name="cfn-wafv2-loggingconfiguration-filter-behavior"></a>
How to handle logs that satisfy the filter's conditions and requirement.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `KEEP | DROP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Conditions`  <a name="cfn-wafv2-loggingconfiguration-filter-conditions"></a>
Match conditions for the filter.  
*Required*: Yes  
*Type*: Array of [Condition](aws-properties-wafv2-loggingconfiguration-condition.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Requirement`  <a name="cfn-wafv2-loggingconfiguration-filter-requirement"></a>
Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `MEETS_ALL | MEETS_ANY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WAFv2::LoggingConfiguration LabelNameCondition
<a name="aws-properties-wafv2-loggingconfiguration-labelnamecondition"></a>

A single label name condition for a condition in a logging filter.

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-labelnamecondition-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-labelnamecondition-syntax.json"></a>

```
{
  "[LabelName](#cfn-wafv2-loggingconfiguration-labelnamecondition-labelname)" : String
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-labelnamecondition-syntax.yaml"></a>

```
  [LabelName](#cfn-wafv2-loggingconfiguration-labelnamecondition-labelname): String
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-labelnamecondition-properties"></a>

`LabelName`  <a name="cfn-wafv2-loggingconfiguration-labelnamecondition-labelname"></a>
The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^[0-9A-Za-z_\-:]+$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WAFv2::LoggingConfiguration LoggingFilter
<a name="aws-properties-wafv2-loggingconfiguration-loggingfilter"></a>

Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's `LoggingConfiguration`. 

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. 

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-loggingfilter-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-loggingfilter-syntax.json"></a>

```
{
  "[DefaultBehavior](#cfn-wafv2-loggingconfiguration-loggingfilter-defaultbehavior)" : String,
  "[Filters](#cfn-wafv2-loggingconfiguration-loggingfilter-filters)" : [ Filter, ... ]
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-loggingfilter-syntax.yaml"></a>

```
  [DefaultBehavior](#cfn-wafv2-loggingconfiguration-loggingfilter-defaultbehavior): String
  [Filters](#cfn-wafv2-loggingconfiguration-loggingfilter-filters): 
    - Filter
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-loggingfilter-properties"></a>

`DefaultBehavior`  <a name="cfn-wafv2-loggingconfiguration-loggingfilter-defaultbehavior"></a>
Default handling for logs that don't match any of the specified filtering conditions.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `KEEP | DROP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Filters`  <a name="cfn-wafv2-loggingconfiguration-loggingfilter-filters"></a>
The filters that you want to apply to the logs.   
*Required*: Yes  
*Type*: Array of [Filter](aws-properties-wafv2-loggingconfiguration-filter.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WAFv2::LoggingConfiguration SingleHeader
<a name="aws-properties-wafv2-loggingconfiguration-singleheader"></a>

Inspect one of the headers in the web request, identified by name, for example, `User-Agent` or `Referer`. The name isn't case sensitive.

You can filter and inspect all headers with the `FieldToMatch` setting `Headers`.

This is used to indicate the web request component to inspect, in the `FieldToMatch` specification. 

Example JSON: `"SingleHeader": { "Name": "haystack" }`

## Syntax
<a name="aws-properties-wafv2-loggingconfiguration-singleheader-syntax"></a>

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

### JSON
<a name="aws-properties-wafv2-loggingconfiguration-singleheader-syntax.json"></a>

```
{
  "[Name](#cfn-wafv2-loggingconfiguration-singleheader-name)" : String
}
```

### YAML
<a name="aws-properties-wafv2-loggingconfiguration-singleheader-syntax.yaml"></a>

```
  [Name](#cfn-wafv2-loggingconfiguration-singleheader-name): String
```

## Properties
<a name="aws-properties-wafv2-loggingconfiguration-singleheader-properties"></a>

`Name`  <a name="cfn-wafv2-loggingconfiguration-singleheader-name"></a>
The name of the query header to inspect.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.*\S.*`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)