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 |
Synopsis
- data RuleGroupSummary = RuleGroupSummary' {}
- newRuleGroupSummary :: RuleGroupSummary
- ruleGroupSummary_arn :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_description :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_id :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_lockToken :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_name :: Lens' RuleGroupSummary (Maybe Text)
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.
RuleGroupSummary' | |
|
Instances
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.