Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WAFV2.Types.RuleGroupSummary

Description

Synopsis

Documentation

data RuleGroupSummary Source #

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

See: newRuleGroupSummary smart constructor.

Constructors

RuleGroupSummary'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the entity.
description :: Maybe Text
A description of the rule group that helps with identification.
id :: Maybe Text
A unique identifier for the rule group. 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

Instances details

FromJSON RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Methods parseJSON :: Value -> Parser RuleGroupSummary # parseJSONList :: Value -> Parser [RuleGroupSummary] #
Generic RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Associated Types type Rep RuleGroupSummary :: Type -> Type # Methods from :: RuleGroupSummary -> Rep RuleGroupSummary x # to :: Rep RuleGroupSummary x -> RuleGroupSummary #
Read RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Methods readsPrec :: Int -> ReadS RuleGroupSummary # readList :: ReadS [RuleGroupSummary] # readPrec :: ReadPrec RuleGroupSummary # readListPrec :: ReadPrec [RuleGroupSummary] #
Show RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Methods showsPrec :: Int -> RuleGroupSummary -> ShowS # show :: RuleGroupSummary -> String # showList :: [RuleGroupSummary] -> ShowS #
NFData RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Methods rnf :: RuleGroupSummary -> () #
Eq RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Methods (==) :: RuleGroupSummary -> RuleGroupSummary -> Bool # (/=) :: RuleGroupSummary -> RuleGroupSummary -> Bool #
Hashable RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary Methods hashWithSalt :: Int -> RuleGroupSummary -> Int # hash :: RuleGroupSummary -> Int #
type Rep RuleGroupSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.RuleGroupSummary type Rep RuleGroupSummary = D1 ('MetaData "RuleGroupSummary" "Amazonka.WAFV2.Types.RuleGroupSummary" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "RuleGroupSummary'" '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))))))

newRuleGroupSummary :: RuleGroupSummary Source #

Create a value of RuleGroupSummary 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:RuleGroupSummary', ruleGroupSummary_arn - The Amazon Resource Name (ARN) of the entity.

$sel:description:RuleGroupSummary', ruleGroupSummary_description - A description of the rule group that helps with identification.

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

$sel:lockToken:RuleGroupSummary', ruleGroupSummary_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:RuleGroupSummary', ruleGroupSummary_name - The name of the data type instance. You cannot change the name after you create the instance.

ruleGroupSummary_arn :: Lens' RuleGroupSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the entity.

ruleGroupSummary_description :: Lens' RuleGroupSummary (Maybe Text) Source #

A description of the rule group that helps with identification.

ruleGroupSummary_id :: Lens' RuleGroupSummary (Maybe Text) Source #

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

ruleGroupSummary_lockToken :: Lens' RuleGroupSummary (Maybe Text) Source #

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.

ruleGroupSummary_name :: Lens' RuleGroupSummary (Maybe Text) Source #

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