{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.WAFRegional.Types.ByteMatchTuple
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.WAFRegional.Types.ByteMatchTuple where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.WAFRegional.Types.FieldToMatch
import Amazonka.WAFRegional.Types.PositionalConstraint
import Amazonka.WAFRegional.Types.TextTransformation

-- | This is __AWS WAF Classic__ documentation. For more information, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html AWS WAF Classic>
-- in the developer guide.
--
-- __For the latest version of AWS WAF__, use the AWS WAFV2 API and see the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html AWS WAF Developer Guide>.
-- With the latest version, AWS WAF has a single set of endpoints for
-- regional and global use.
--
-- The bytes (typically a string that corresponds with ASCII characters)
-- that you want AWS WAF to search for in web requests, the location in
-- requests that you want AWS WAF to search, and other settings.
--
-- /See:/ 'newByteMatchTuple' smart constructor.
data ByteMatchTuple = ByteMatchTuple'
  { -- | The part of a web request that you want AWS WAF to search, such as a
    -- specified header or a query string. For more information, see
    -- FieldToMatch.
    ByteMatchTuple -> FieldToMatch
fieldToMatch :: FieldToMatch,
    -- | The value that you want AWS WAF to search for. AWS WAF searches for the
    -- specified string in the part of web requests that you specified in
    -- @FieldToMatch@. The maximum length of the value is 50 bytes.
    --
    -- Valid values depend on the values that you specified for @FieldToMatch@:
    --
    -- -   @HEADER@: The value that you want AWS WAF to search for in the
    --     request header that you specified in FieldToMatch, for example, the
    --     value of the @User-Agent@ or @Referer@ header.
    --
    -- -   @METHOD@: The HTTP method, which indicates the type of operation
    --     specified in the request. CloudFront supports the following methods:
    --     @DELETE@, @GET@, @HEAD@, @OPTIONS@, @PATCH@, @POST@, and @PUT@.
    --
    -- -   @QUERY_STRING@: The value that you want AWS WAF to search for in the
    --     query string, which is the part of a URL that appears after a @?@
    --     character.
    --
    -- -   @URI@: The value that you want AWS WAF to search for in the part of
    --     a URL that identifies a resource, for example,
    --     @\/images\/daily-ad.jpg@.
    --
    -- -   @BODY@: The part of a request that contains any additional data that
    --     you want to send to your web server as the HTTP request body, such
    --     as data from a form. The request body immediately follows the
    --     request headers. Note that only the first @8192@ bytes of the
    --     request body are forwarded to AWS WAF for inspection. To allow or
    --     block requests based on the length of the body, you can create a
    --     size constraint set. For more information, see
    --     CreateSizeConstraintSet.
    --
    -- -   @SINGLE_QUERY_ARG@: The parameter in the query string that you will
    --     inspect, such as /UserName/ or /SalesRegion/. The maximum length for
    --     @SINGLE_QUERY_ARG@ is 30 characters.
    --
    -- -   @ALL_QUERY_ARGS@: Similar to @SINGLE_QUERY_ARG@, but instead of
    --     inspecting a single parameter, AWS WAF inspects all parameters
    --     within the query string for the value or regex pattern that you
    --     specify in @TargetString@.
    --
    -- If @TargetString@ includes alphabetic characters A-Z and a-z, note that
    -- the value is case sensitive.
    --
    -- __If you\'re using the AWS WAF API__
    --
    -- Specify a base64-encoded version of the value. The maximum length of the
    -- value before you base64-encode it is 50 bytes.
    --
    -- For example, suppose the value of @Type@ is @HEADER@ and the value of
    -- @Data@ is @User-Agent@. If you want to search the @User-Agent@ header
    -- for the value @BadBot@, you base64-encode @BadBot@ using MIME
    -- base64-encoding and include the resulting value, @QmFkQm90@, in the
    -- value of @TargetString@.
    --
    -- __If you\'re using the AWS CLI or one of the AWS SDKs__
    --
    -- The value that you want AWS WAF to search for. The SDK automatically
    -- base64 encodes the value.
    ByteMatchTuple -> Base64
targetString :: Core.Base64,
    -- | Text transformations eliminate some of the unusual formatting that
    -- attackers use in web requests in an effort to bypass AWS WAF. If you
    -- specify a transformation, AWS WAF performs the transformation on
    -- @FieldToMatch@ before inspecting it for a match.
    --
    -- You can only specify a single type of TextTransformation.
    --
    -- __CMD_LINE__
    --
    -- When you\'re concerned that attackers are injecting an operating system
    -- command line command and using unusual formatting to disguise some or
    -- all of the command, use this option to perform the following
    -- transformations:
    --
    -- -   Delete the following characters: \\ \" \' ^
    --
    -- -   Delete spaces before the following characters: \/ (
    --
    -- -   Replace the following characters with a space: , ;
    --
    -- -   Replace multiple spaces with one space
    --
    -- -   Convert uppercase letters (A-Z) to lowercase (a-z)
    --
    -- __COMPRESS_WHITE_SPACE__
    --
    -- Use this option to replace the following characters with a space
    -- character (decimal 32):
    --
    -- -   \\f, formfeed, decimal 12
    --
    -- -   \\t, tab, decimal 9
    --
    -- -   \\n, newline, decimal 10
    --
    -- -   \\r, carriage return, decimal 13
    --
    -- -   \\v, vertical tab, decimal 11
    --
    -- -   non-breaking space, decimal 160
    --
    -- @COMPRESS_WHITE_SPACE@ also replaces multiple spaces with one space.
    --
    -- __HTML_ENTITY_DECODE__
    --
    -- Use this option to replace HTML-encoded characters with unencoded
    -- characters. @HTML_ENTITY_DECODE@ performs the following operations:
    --
    -- -   Replaces @(ampersand)quot;@ with @\"@
    --
    -- -   Replaces @(ampersand)nbsp;@ with a non-breaking space, decimal 160
    --
    -- -   Replaces @(ampersand)lt;@ with a \"less than\" symbol
    --
    -- -   Replaces @(ampersand)gt;@ with @>@
    --
    -- -   Replaces characters that are represented in hexadecimal format,
    --     @(ampersand)#xhhhh;@, with the corresponding characters
    --
    -- -   Replaces characters that are represented in decimal format,
    --     @(ampersand)#nnnn;@, with the corresponding characters
    --
    -- __LOWERCASE__
    --
    -- Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
    --
    -- __URL_DECODE__
    --
    -- Use this option to decode a URL-encoded value.
    --
    -- __NONE__
    --
    -- Specify @NONE@ if you don\'t want to perform any text transformations.
    ByteMatchTuple -> TextTransformation
textTransformation :: TextTransformation,
    -- | Within the portion of a web request that you want to search (for
    -- example, in the query string, if any), specify where you want AWS WAF to
    -- search. Valid values include the following:
    --
    -- __CONTAINS__
    --
    -- The specified part of the web request must include the value of
    -- @TargetString@, but the location doesn\'t matter.
    --
    -- __CONTAINS_WORD__
    --
    -- The specified part of the web request must include the value of
    -- @TargetString@, and @TargetString@ must contain only alphanumeric
    -- characters or underscore (A-Z, a-z, 0-9, or _). In addition,
    -- @TargetString@ must be a word, which means one of the following:
    --
    -- -   @TargetString@ exactly matches the value of the specified part of
    --     the web request, such as the value of a header.
    --
    -- -   @TargetString@ is at the beginning of the specified part of the web
    --     request and is followed by a character other than an alphanumeric
    --     character or underscore (_), for example, @BadBot;@.
    --
    -- -   @TargetString@ is at the end of the specified part of the web
    --     request and is preceded by a character other than an alphanumeric
    --     character or underscore (_), for example, @;BadBot@.
    --
    -- -   @TargetString@ is in the middle of the specified part of the web
    --     request and is preceded and followed by characters other than
    --     alphanumeric characters or underscore (_), for example, @-BadBot;@.
    --
    -- __EXACTLY__
    --
    -- The value of the specified part of the web request must exactly match
    -- the value of @TargetString@.
    --
    -- __STARTS_WITH__
    --
    -- The value of @TargetString@ must appear at the beginning of the
    -- specified part of the web request.
    --
    -- __ENDS_WITH__
    --
    -- The value of @TargetString@ must appear at the end of the specified part
    -- of the web request.
    ByteMatchTuple -> PositionalConstraint
positionalConstraint :: PositionalConstraint
  }
  deriving (ByteMatchTuple -> ByteMatchTuple -> Bool
(ByteMatchTuple -> ByteMatchTuple -> Bool)
-> (ByteMatchTuple -> ByteMatchTuple -> Bool) -> Eq ByteMatchTuple
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ByteMatchTuple -> ByteMatchTuple -> Bool
$c/= :: ByteMatchTuple -> ByteMatchTuple -> Bool
== :: ByteMatchTuple -> ByteMatchTuple -> Bool
$c== :: ByteMatchTuple -> ByteMatchTuple -> Bool
Prelude.Eq, ReadPrec [ByteMatchTuple]
ReadPrec ByteMatchTuple
Int -> ReadS ByteMatchTuple
ReadS [ByteMatchTuple]
(Int -> ReadS ByteMatchTuple)
-> ReadS [ByteMatchTuple]
-> ReadPrec ByteMatchTuple
-> ReadPrec [ByteMatchTuple]
-> Read ByteMatchTuple
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ByteMatchTuple]
$creadListPrec :: ReadPrec [ByteMatchTuple]
readPrec :: ReadPrec ByteMatchTuple
$creadPrec :: ReadPrec ByteMatchTuple
readList :: ReadS [ByteMatchTuple]
$creadList :: ReadS [ByteMatchTuple]
readsPrec :: Int -> ReadS ByteMatchTuple
$creadsPrec :: Int -> ReadS ByteMatchTuple
Prelude.Read, Int -> ByteMatchTuple -> ShowS
[ByteMatchTuple] -> ShowS
ByteMatchTuple -> String
(Int -> ByteMatchTuple -> ShowS)
-> (ByteMatchTuple -> String)
-> ([ByteMatchTuple] -> ShowS)
-> Show ByteMatchTuple
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ByteMatchTuple] -> ShowS
$cshowList :: [ByteMatchTuple] -> ShowS
show :: ByteMatchTuple -> String
$cshow :: ByteMatchTuple -> String
showsPrec :: Int -> ByteMatchTuple -> ShowS
$cshowsPrec :: Int -> ByteMatchTuple -> ShowS
Prelude.Show, (forall x. ByteMatchTuple -> Rep ByteMatchTuple x)
-> (forall x. Rep ByteMatchTuple x -> ByteMatchTuple)
-> Generic ByteMatchTuple
forall x. Rep ByteMatchTuple x -> ByteMatchTuple
forall x. ByteMatchTuple -> Rep ByteMatchTuple x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ByteMatchTuple x -> ByteMatchTuple
$cfrom :: forall x. ByteMatchTuple -> Rep ByteMatchTuple x
Prelude.Generic)

-- |
-- Create a value of 'ByteMatchTuple' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'fieldToMatch', 'byteMatchTuple_fieldToMatch' - The part of a web request that you want AWS WAF to search, such as a
-- specified header or a query string. For more information, see
-- FieldToMatch.
--
-- 'targetString', 'byteMatchTuple_targetString' - The value that you want AWS WAF to search for. AWS WAF searches for the
-- specified string in the part of web requests that you specified in
-- @FieldToMatch@. The maximum length of the value is 50 bytes.
--
-- Valid values depend on the values that you specified for @FieldToMatch@:
--
-- -   @HEADER@: The value that you want AWS WAF to search for in the
--     request header that you specified in FieldToMatch, for example, the
--     value of the @User-Agent@ or @Referer@ header.
--
-- -   @METHOD@: The HTTP method, which indicates the type of operation
--     specified in the request. CloudFront supports the following methods:
--     @DELETE@, @GET@, @HEAD@, @OPTIONS@, @PATCH@, @POST@, and @PUT@.
--
-- -   @QUERY_STRING@: The value that you want AWS WAF to search for in the
--     query string, which is the part of a URL that appears after a @?@
--     character.
--
-- -   @URI@: The value that you want AWS WAF to search for in the part of
--     a URL that identifies a resource, for example,
--     @\/images\/daily-ad.jpg@.
--
-- -   @BODY@: The part of a request that contains any additional data that
--     you want to send to your web server as the HTTP request body, such
--     as data from a form. The request body immediately follows the
--     request headers. Note that only the first @8192@ bytes of the
--     request body are forwarded to AWS WAF for inspection. To allow or
--     block requests based on the length of the body, you can create a
--     size constraint set. For more information, see
--     CreateSizeConstraintSet.
--
-- -   @SINGLE_QUERY_ARG@: The parameter in the query string that you will
--     inspect, such as /UserName/ or /SalesRegion/. The maximum length for
--     @SINGLE_QUERY_ARG@ is 30 characters.
--
-- -   @ALL_QUERY_ARGS@: Similar to @SINGLE_QUERY_ARG@, but instead of
--     inspecting a single parameter, AWS WAF inspects all parameters
--     within the query string for the value or regex pattern that you
--     specify in @TargetString@.
--
-- If @TargetString@ includes alphabetic characters A-Z and a-z, note that
-- the value is case sensitive.
--
-- __If you\'re using the AWS WAF API__
--
-- Specify a base64-encoded version of the value. The maximum length of the
-- value before you base64-encode it is 50 bytes.
--
-- For example, suppose the value of @Type@ is @HEADER@ and the value of
-- @Data@ is @User-Agent@. If you want to search the @User-Agent@ header
-- for the value @BadBot@, you base64-encode @BadBot@ using MIME
-- base64-encoding and include the resulting value, @QmFkQm90@, in the
-- value of @TargetString@.
--
-- __If you\'re using the AWS CLI or one of the AWS SDKs__
--
-- The value that you want AWS WAF to search for. The SDK automatically
-- base64 encodes the value.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
--
-- 'textTransformation', 'byteMatchTuple_textTransformation' - Text transformations eliminate some of the unusual formatting that
-- attackers use in web requests in an effort to bypass AWS WAF. If you
-- specify a transformation, AWS WAF performs the transformation on
-- @FieldToMatch@ before inspecting it for a match.
--
-- You can only specify a single type of TextTransformation.
--
-- __CMD_LINE__
--
-- When you\'re concerned that attackers are injecting an operating system
-- command line command and using unusual formatting to disguise some or
-- all of the command, use this option to perform the following
-- transformations:
--
-- -   Delete the following characters: \\ \" \' ^
--
-- -   Delete spaces before the following characters: \/ (
--
-- -   Replace the following characters with a space: , ;
--
-- -   Replace multiple spaces with one space
--
-- -   Convert uppercase letters (A-Z) to lowercase (a-z)
--
-- __COMPRESS_WHITE_SPACE__
--
-- Use this option to replace the following characters with a space
-- character (decimal 32):
--
-- -   \\f, formfeed, decimal 12
--
-- -   \\t, tab, decimal 9
--
-- -   \\n, newline, decimal 10
--
-- -   \\r, carriage return, decimal 13
--
-- -   \\v, vertical tab, decimal 11
--
-- -   non-breaking space, decimal 160
--
-- @COMPRESS_WHITE_SPACE@ also replaces multiple spaces with one space.
--
-- __HTML_ENTITY_DECODE__
--
-- Use this option to replace HTML-encoded characters with unencoded
-- characters. @HTML_ENTITY_DECODE@ performs the following operations:
--
-- -   Replaces @(ampersand)quot;@ with @\"@
--
-- -   Replaces @(ampersand)nbsp;@ with a non-breaking space, decimal 160
--
-- -   Replaces @(ampersand)lt;@ with a \"less than\" symbol
--
-- -   Replaces @(ampersand)gt;@ with @>@
--
-- -   Replaces characters that are represented in hexadecimal format,
--     @(ampersand)#xhhhh;@, with the corresponding characters
--
-- -   Replaces characters that are represented in decimal format,
--     @(ampersand)#nnnn;@, with the corresponding characters
--
-- __LOWERCASE__
--
-- Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
--
-- __URL_DECODE__
--
-- Use this option to decode a URL-encoded value.
--
-- __NONE__
--
-- Specify @NONE@ if you don\'t want to perform any text transformations.
--
-- 'positionalConstraint', 'byteMatchTuple_positionalConstraint' - Within the portion of a web request that you want to search (for
-- example, in the query string, if any), specify where you want AWS WAF to
-- search. Valid values include the following:
--
-- __CONTAINS__
--
-- The specified part of the web request must include the value of
-- @TargetString@, but the location doesn\'t matter.
--
-- __CONTAINS_WORD__
--
-- The specified part of the web request must include the value of
-- @TargetString@, and @TargetString@ must contain only alphanumeric
-- characters or underscore (A-Z, a-z, 0-9, or _). In addition,
-- @TargetString@ must be a word, which means one of the following:
--
-- -   @TargetString@ exactly matches the value of the specified part of
--     the web request, such as the value of a header.
--
-- -   @TargetString@ is at the beginning of the specified part of the web
--     request and is followed by a character other than an alphanumeric
--     character or underscore (_), for example, @BadBot;@.
--
-- -   @TargetString@ is at the end of the specified part of the web
--     request and is preceded by a character other than an alphanumeric
--     character or underscore (_), for example, @;BadBot@.
--
-- -   @TargetString@ is in the middle of the specified part of the web
--     request and is preceded and followed by characters other than
--     alphanumeric characters or underscore (_), for example, @-BadBot;@.
--
-- __EXACTLY__
--
-- The value of the specified part of the web request must exactly match
-- the value of @TargetString@.
--
-- __STARTS_WITH__
--
-- The value of @TargetString@ must appear at the beginning of the
-- specified part of the web request.
--
-- __ENDS_WITH__
--
-- The value of @TargetString@ must appear at the end of the specified part
-- of the web request.
newByteMatchTuple ::
  -- | 'fieldToMatch'
  FieldToMatch ->
  -- | 'targetString'
  Prelude.ByteString ->
  -- | 'textTransformation'
  TextTransformation ->
  -- | 'positionalConstraint'
  PositionalConstraint ->
  ByteMatchTuple
newByteMatchTuple :: FieldToMatch
-> ByteString
-> TextTransformation
-> PositionalConstraint
-> ByteMatchTuple
newByteMatchTuple
  FieldToMatch
pFieldToMatch_
  ByteString
pTargetString_
  TextTransformation
pTextTransformation_
  PositionalConstraint
pPositionalConstraint_ =
    ByteMatchTuple' :: FieldToMatch
-> Base64
-> TextTransformation
-> PositionalConstraint
-> ByteMatchTuple
ByteMatchTuple'
      { $sel:fieldToMatch:ByteMatchTuple' :: FieldToMatch
fieldToMatch = FieldToMatch
pFieldToMatch_,
        $sel:targetString:ByteMatchTuple' :: Base64
targetString = Tagged ByteString (Identity ByteString)
-> Tagged Base64 (Identity Base64)
Iso' Base64 ByteString
Core._Base64 (Tagged ByteString (Identity ByteString)
 -> Tagged Base64 (Identity Base64))
-> ByteString -> Base64
forall t b. AReview t b -> b -> t
Lens.# ByteString
pTargetString_,
        $sel:textTransformation:ByteMatchTuple' :: TextTransformation
textTransformation = TextTransformation
pTextTransformation_,
        $sel:positionalConstraint:ByteMatchTuple' :: PositionalConstraint
positionalConstraint = PositionalConstraint
pPositionalConstraint_
      }

-- | The part of a web request that you want AWS WAF to search, such as a
-- specified header or a query string. For more information, see
-- FieldToMatch.
byteMatchTuple_fieldToMatch :: Lens.Lens' ByteMatchTuple FieldToMatch
byteMatchTuple_fieldToMatch :: (FieldToMatch -> f FieldToMatch)
-> ByteMatchTuple -> f ByteMatchTuple
byteMatchTuple_fieldToMatch = (ByteMatchTuple -> FieldToMatch)
-> (ByteMatchTuple -> FieldToMatch -> ByteMatchTuple)
-> Lens ByteMatchTuple ByteMatchTuple FieldToMatch FieldToMatch
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ByteMatchTuple' {FieldToMatch
fieldToMatch :: FieldToMatch
$sel:fieldToMatch:ByteMatchTuple' :: ByteMatchTuple -> FieldToMatch
fieldToMatch} -> FieldToMatch
fieldToMatch) (\s :: ByteMatchTuple
s@ByteMatchTuple' {} FieldToMatch
a -> ByteMatchTuple
s {$sel:fieldToMatch:ByteMatchTuple' :: FieldToMatch
fieldToMatch = FieldToMatch
a} :: ByteMatchTuple)

-- | The value that you want AWS WAF to search for. AWS WAF searches for the
-- specified string in the part of web requests that you specified in
-- @FieldToMatch@. The maximum length of the value is 50 bytes.
--
-- Valid values depend on the values that you specified for @FieldToMatch@:
--
-- -   @HEADER@: The value that you want AWS WAF to search for in the
--     request header that you specified in FieldToMatch, for example, the
--     value of the @User-Agent@ or @Referer@ header.
--
-- -   @METHOD@: The HTTP method, which indicates the type of operation
--     specified in the request. CloudFront supports the following methods:
--     @DELETE@, @GET@, @HEAD@, @OPTIONS@, @PATCH@, @POST@, and @PUT@.
--
-- -   @QUERY_STRING@: The value that you want AWS WAF to search for in the
--     query string, which is the part of a URL that appears after a @?@
--     character.
--
-- -   @URI@: The value that you want AWS WAF to search for in the part of
--     a URL that identifies a resource, for example,
--     @\/images\/daily-ad.jpg@.
--
-- -   @BODY@: The part of a request that contains any additional data that
--     you want to send to your web server as the HTTP request body, such
--     as data from a form. The request body immediately follows the
--     request headers. Note that only the first @8192@ bytes of the
--     request body are forwarded to AWS WAF for inspection. To allow or
--     block requests based on the length of the body, you can create a
--     size constraint set. For more information, see
--     CreateSizeConstraintSet.
--
-- -   @SINGLE_QUERY_ARG@: The parameter in the query string that you will
--     inspect, such as /UserName/ or /SalesRegion/. The maximum length for
--     @SINGLE_QUERY_ARG@ is 30 characters.
--
-- -   @ALL_QUERY_ARGS@: Similar to @SINGLE_QUERY_ARG@, but instead of
--     inspecting a single parameter, AWS WAF inspects all parameters
--     within the query string for the value or regex pattern that you
--     specify in @TargetString@.
--
-- If @TargetString@ includes alphabetic characters A-Z and a-z, note that
-- the value is case sensitive.
--
-- __If you\'re using the AWS WAF API__
--
-- Specify a base64-encoded version of the value. The maximum length of the
-- value before you base64-encode it is 50 bytes.
--
-- For example, suppose the value of @Type@ is @HEADER@ and the value of
-- @Data@ is @User-Agent@. If you want to search the @User-Agent@ header
-- for the value @BadBot@, you base64-encode @BadBot@ using MIME
-- base64-encoding and include the resulting value, @QmFkQm90@, in the
-- value of @TargetString@.
--
-- __If you\'re using the AWS CLI or one of the AWS SDKs__
--
-- The value that you want AWS WAF to search for. The SDK automatically
-- base64 encodes the value.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
byteMatchTuple_targetString :: Lens.Lens' ByteMatchTuple Prelude.ByteString
byteMatchTuple_targetString :: (ByteString -> f ByteString) -> ByteMatchTuple -> f ByteMatchTuple
byteMatchTuple_targetString = (ByteMatchTuple -> Base64)
-> (ByteMatchTuple -> Base64 -> ByteMatchTuple)
-> Lens ByteMatchTuple ByteMatchTuple Base64 Base64
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ByteMatchTuple' {Base64
targetString :: Base64
$sel:targetString:ByteMatchTuple' :: ByteMatchTuple -> Base64
targetString} -> Base64
targetString) (\s :: ByteMatchTuple
s@ByteMatchTuple' {} Base64
a -> ByteMatchTuple
s {$sel:targetString:ByteMatchTuple' :: Base64
targetString = Base64
a} :: ByteMatchTuple) ((Base64 -> f Base64) -> ByteMatchTuple -> f ByteMatchTuple)
-> ((ByteString -> f ByteString) -> Base64 -> f Base64)
-> (ByteString -> f ByteString)
-> ByteMatchTuple
-> f ByteMatchTuple
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (ByteString -> f ByteString) -> Base64 -> f Base64
Iso' Base64 ByteString
Core._Base64

-- | Text transformations eliminate some of the unusual formatting that
-- attackers use in web requests in an effort to bypass AWS WAF. If you
-- specify a transformation, AWS WAF performs the transformation on
-- @FieldToMatch@ before inspecting it for a match.
--
-- You can only specify a single type of TextTransformation.
--
-- __CMD_LINE__
--
-- When you\'re concerned that attackers are injecting an operating system
-- command line command and using unusual formatting to disguise some or
-- all of the command, use this option to perform the following
-- transformations:
--
-- -   Delete the following characters: \\ \" \' ^
--
-- -   Delete spaces before the following characters: \/ (
--
-- -   Replace the following characters with a space: , ;
--
-- -   Replace multiple spaces with one space
--
-- -   Convert uppercase letters (A-Z) to lowercase (a-z)
--
-- __COMPRESS_WHITE_SPACE__
--
-- Use this option to replace the following characters with a space
-- character (decimal 32):
--
-- -   \\f, formfeed, decimal 12
--
-- -   \\t, tab, decimal 9
--
-- -   \\n, newline, decimal 10
--
-- -   \\r, carriage return, decimal 13
--
-- -   \\v, vertical tab, decimal 11
--
-- -   non-breaking space, decimal 160
--
-- @COMPRESS_WHITE_SPACE@ also replaces multiple spaces with one space.
--
-- __HTML_ENTITY_DECODE__
--
-- Use this option to replace HTML-encoded characters with unencoded
-- characters. @HTML_ENTITY_DECODE@ performs the following operations:
--
-- -   Replaces @(ampersand)quot;@ with @\"@
--
-- -   Replaces @(ampersand)nbsp;@ with a non-breaking space, decimal 160
--
-- -   Replaces @(ampersand)lt;@ with a \"less than\" symbol
--
-- -   Replaces @(ampersand)gt;@ with @>@
--
-- -   Replaces characters that are represented in hexadecimal format,
--     @(ampersand)#xhhhh;@, with the corresponding characters
--
-- -   Replaces characters that are represented in decimal format,
--     @(ampersand)#nnnn;@, with the corresponding characters
--
-- __LOWERCASE__
--
-- Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
--
-- __URL_DECODE__
--
-- Use this option to decode a URL-encoded value.
--
-- __NONE__
--
-- Specify @NONE@ if you don\'t want to perform any text transformations.
byteMatchTuple_textTransformation :: Lens.Lens' ByteMatchTuple TextTransformation
byteMatchTuple_textTransformation :: (TextTransformation -> f TextTransformation)
-> ByteMatchTuple -> f ByteMatchTuple
byteMatchTuple_textTransformation = (ByteMatchTuple -> TextTransformation)
-> (ByteMatchTuple -> TextTransformation -> ByteMatchTuple)
-> Lens
     ByteMatchTuple ByteMatchTuple TextTransformation TextTransformation
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ByteMatchTuple' {TextTransformation
textTransformation :: TextTransformation
$sel:textTransformation:ByteMatchTuple' :: ByteMatchTuple -> TextTransformation
textTransformation} -> TextTransformation
textTransformation) (\s :: ByteMatchTuple
s@ByteMatchTuple' {} TextTransformation
a -> ByteMatchTuple
s {$sel:textTransformation:ByteMatchTuple' :: TextTransformation
textTransformation = TextTransformation
a} :: ByteMatchTuple)

-- | Within the portion of a web request that you want to search (for
-- example, in the query string, if any), specify where you want AWS WAF to
-- search. Valid values include the following:
--
-- __CONTAINS__
--
-- The specified part of the web request must include the value of
-- @TargetString@, but the location doesn\'t matter.
--
-- __CONTAINS_WORD__
--
-- The specified part of the web request must include the value of
-- @TargetString@, and @TargetString@ must contain only alphanumeric
-- characters or underscore (A-Z, a-z, 0-9, or _). In addition,
-- @TargetString@ must be a word, which means one of the following:
--
-- -   @TargetString@ exactly matches the value of the specified part of
--     the web request, such as the value of a header.
--
-- -   @TargetString@ is at the beginning of the specified part of the web
--     request and is followed by a character other than an alphanumeric
--     character or underscore (_), for example, @BadBot;@.
--
-- -   @TargetString@ is at the end of the specified part of the web
--     request and is preceded by a character other than an alphanumeric
--     character or underscore (_), for example, @;BadBot@.
--
-- -   @TargetString@ is in the middle of the specified part of the web
--     request and is preceded and followed by characters other than
--     alphanumeric characters or underscore (_), for example, @-BadBot;@.
--
-- __EXACTLY__
--
-- The value of the specified part of the web request must exactly match
-- the value of @TargetString@.
--
-- __STARTS_WITH__
--
-- The value of @TargetString@ must appear at the beginning of the
-- specified part of the web request.
--
-- __ENDS_WITH__
--
-- The value of @TargetString@ must appear at the end of the specified part
-- of the web request.
byteMatchTuple_positionalConstraint :: Lens.Lens' ByteMatchTuple PositionalConstraint
byteMatchTuple_positionalConstraint :: (PositionalConstraint -> f PositionalConstraint)
-> ByteMatchTuple -> f ByteMatchTuple
byteMatchTuple_positionalConstraint = (ByteMatchTuple -> PositionalConstraint)
-> (ByteMatchTuple -> PositionalConstraint -> ByteMatchTuple)
-> Lens
     ByteMatchTuple
     ByteMatchTuple
     PositionalConstraint
     PositionalConstraint
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ByteMatchTuple' {PositionalConstraint
positionalConstraint :: PositionalConstraint
$sel:positionalConstraint:ByteMatchTuple' :: ByteMatchTuple -> PositionalConstraint
positionalConstraint} -> PositionalConstraint
positionalConstraint) (\s :: ByteMatchTuple
s@ByteMatchTuple' {} PositionalConstraint
a -> ByteMatchTuple
s {$sel:positionalConstraint:ByteMatchTuple' :: PositionalConstraint
positionalConstraint = PositionalConstraint
a} :: ByteMatchTuple)

instance Core.FromJSON ByteMatchTuple where
  parseJSON :: Value -> Parser ByteMatchTuple
parseJSON =
    String
-> (Object -> Parser ByteMatchTuple)
-> Value
-> Parser ByteMatchTuple
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"ByteMatchTuple"
      ( \Object
x ->
          FieldToMatch
-> Base64
-> TextTransformation
-> PositionalConstraint
-> ByteMatchTuple
ByteMatchTuple'
            (FieldToMatch
 -> Base64
 -> TextTransformation
 -> PositionalConstraint
 -> ByteMatchTuple)
-> Parser FieldToMatch
-> Parser
     (Base64
      -> TextTransformation -> PositionalConstraint -> ByteMatchTuple)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser FieldToMatch
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"FieldToMatch")
            Parser
  (Base64
   -> TextTransformation -> PositionalConstraint -> ByteMatchTuple)
-> Parser Base64
-> Parser
     (TextTransformation -> PositionalConstraint -> ByteMatchTuple)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser Base64
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"TargetString")
            Parser
  (TextTransformation -> PositionalConstraint -> ByteMatchTuple)
-> Parser TextTransformation
-> Parser (PositionalConstraint -> ByteMatchTuple)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser TextTransformation
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"TextTransformation")
            Parser (PositionalConstraint -> ByteMatchTuple)
-> Parser PositionalConstraint -> Parser ByteMatchTuple
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser PositionalConstraint
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"PositionalConstraint")
      )

instance Prelude.Hashable ByteMatchTuple

instance Prelude.NFData ByteMatchTuple

instance Core.ToJSON ByteMatchTuple where
  toJSON :: ByteMatchTuple -> Value
toJSON ByteMatchTuple' {Base64
FieldToMatch
PositionalConstraint
TextTransformation
positionalConstraint :: PositionalConstraint
textTransformation :: TextTransformation
targetString :: Base64
fieldToMatch :: FieldToMatch
$sel:positionalConstraint:ByteMatchTuple' :: ByteMatchTuple -> PositionalConstraint
$sel:textTransformation:ByteMatchTuple' :: ByteMatchTuple -> TextTransformation
$sel:targetString:ByteMatchTuple' :: ByteMatchTuple -> Base64
$sel:fieldToMatch:ByteMatchTuple' :: ByteMatchTuple -> FieldToMatch
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"FieldToMatch" Text -> FieldToMatch -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= FieldToMatch
fieldToMatch),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"TargetString" Text -> Base64 -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Base64
targetString),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"TextTransformation" Text -> TextTransformation -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= TextTransformation
textTransformation),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              ( Text
"PositionalConstraint"
                  Text -> PositionalConstraint -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= PositionalConstraint
positionalConstraint
              )
          ]
      )