Amazonka.WAFV2.Types.RegexPatternSetSummary

Documentation

data RegexPatternSetSummary

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

See: newRegexPatternSetSummary smart constructor.

Constructors

RegexPatternSetSummary'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the entity.

• description :: Maybe Text

  A description of the set that helps with identification.

• id :: Maybe Text

  A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

• lockToken :: Maybe Text

  A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

• name :: Maybe Text

  The name of the data type instance. You cannot change the name after you create the instance.

Instances

FromJSON RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Methods

parseJSON :: Value -> Parser RegexPatternSetSummary

parseJSONList :: Value -> Parser [RegexPatternSetSummary]

Generic RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Associated Types

type Rep RegexPatternSetSummary :: Type -> Type

Methods

from :: RegexPatternSetSummary -> Rep RegexPatternSetSummary x

to :: Rep RegexPatternSetSummary x -> RegexPatternSetSummary

Read RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Methods

readsPrec :: Int -> ReadS RegexPatternSetSummary

readList :: ReadS [RegexPatternSetSummary]

readPrec :: ReadPrec RegexPatternSetSummary

readListPrec :: ReadPrec [RegexPatternSetSummary]

Show RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Methods

showsPrec :: Int -> RegexPatternSetSummary -> ShowS

show :: RegexPatternSetSummary -> String

showList :: [RegexPatternSetSummary] -> ShowS

NFData RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Methods

rnf :: RegexPatternSetSummary -> ()

Eq RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Methods

(==) :: RegexPatternSetSummary -> RegexPatternSetSummary -> Bool

(/=) :: RegexPatternSetSummary -> RegexPatternSetSummary -> Bool

Hashable RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

Methods

hashWithSalt :: Int -> RegexPatternSetSummary -> Int

hash :: RegexPatternSetSummary -> Int

type Rep RegexPatternSetSummary

Defined in Amazonka.WAFV2.Types.RegexPatternSetSummary

type Rep RegexPatternSetSummary = D1 ('MetaData "RegexPatternSetSummary" "Amazonka.WAFV2.Types.RegexPatternSetSummary" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "RegexPatternSetSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newRegexPatternSetSummary :: RegexPatternSetSummary

Create a value of RegexPatternSetSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:RegexPatternSetSummary', regexPatternSetSummary_arn - The Amazon Resource Name (ARN) of the entity.

$sel:description:RegexPatternSetSummary', regexPatternSetSummary_description - A description of the set that helps with identification.

$sel:id:RegexPatternSetSummary', regexPatternSetSummary_id - A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

$sel:lockToken:RegexPatternSetSummary', regexPatternSetSummary_lockToken - A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

$sel:name:RegexPatternSetSummary', regexPatternSetSummary_name - The name of the data type instance. You cannot change the name after you create the instance.

regexPatternSetSummary_arn :: Lens' RegexPatternSetSummary (Maybe Text)

The Amazon Resource Name (ARN) of the entity.

regexPatternSetSummary_description :: Lens' RegexPatternSetSummary (Maybe Text)

A description of the set that helps with identification.

regexPatternSetSummary_id :: Lens' RegexPatternSetSummary (Maybe Text)

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

regexPatternSetSummary_lockToken :: Lens' RegexPatternSetSummary (Maybe Text)

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

regexPatternSetSummary_name :: Lens' RegexPatternSetSummary (Maybe Text)

The name of the data type instance. You cannot change the name after you create the instance.