View a markdown version of this page

AWS::WAFv2::WebACL FieldToProtect - AWS CloudFormation
SyntaxProperties

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.

AWS::WAFv2::WebACL FieldToProtect

Specifies a field type and keys to protect in stored web request data. This is part of the data protection configuration for a web ACL.

Syntax

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

JSON

{
  "FieldKeys" : [ String, ... ],
  "FieldType" : String
}

YAML

  FieldKeys: 
    - String
  FieldType: String

Properties

FieldKeys

Specifies the keys to protect for the specified field type.

Required for SINGLE_HEADER, SINGLE_COOKIE, and SINGLE_QUERY_ARGUMENT: provide a non-empty array naming the specific headers, cookies, or query arguments to protect. There is no option to protect all keys of these field types, so enumerate each key you intend to protect.

Must be omitted for QUERY_STRING and BODY: the entire component is protected and these field types take no keys. Supplying FieldKeys for them is rejected.

Required: No

Type: Array of String

Maximum: 100

Update requires: No interruption

FieldType

Specifies the web request component type to protect.

Required: Yes

Type: String

Allowed values: SINGLE_HEADER | SINGLE_COOKIE | SINGLE_QUERY_ARGUMENT | QUERY_STRING | BODY

Update requires: No interruption