View a markdown version of this page

FieldToProtect - AWS WAFV2

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.

Contents

FieldType

Specifies the web request component type to protect.

Type: String

Valid Values: SINGLE_HEADER | SINGLE_COOKIE | SINGLE_QUERY_ARGUMENT | QUERY_STRING | BODY

Required: Yes

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.

Type: Array of strings

Array Members: Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: