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 |
Provides high-level information for a managed rule group, including descriptions of the rules.
Synopsis
- data DescribeManagedRuleGroup = DescribeManagedRuleGroup' {
- versionName :: Maybe Text
- vendorName :: Text
- name :: Text
- scope :: Scope
- newDescribeManagedRuleGroup :: Text -> Text -> Scope -> DescribeManagedRuleGroup
- describeManagedRuleGroup_versionName :: Lens' DescribeManagedRuleGroup (Maybe Text)
- describeManagedRuleGroup_vendorName :: Lens' DescribeManagedRuleGroup Text
- describeManagedRuleGroup_name :: Lens' DescribeManagedRuleGroup Text
- describeManagedRuleGroup_scope :: Lens' DescribeManagedRuleGroup Scope
- data DescribeManagedRuleGroupResponse = DescribeManagedRuleGroupResponse' {
- availableLabels :: Maybe [LabelSummary]
- capacity :: Maybe Natural
- consumedLabels :: Maybe [LabelSummary]
- labelNamespace :: Maybe Text
- rules :: Maybe [RuleSummary]
- snsTopicArn :: Maybe Text
- versionName :: Maybe Text
- httpStatus :: Int
- newDescribeManagedRuleGroupResponse :: Int -> DescribeManagedRuleGroupResponse
- describeManagedRuleGroupResponse_availableLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary])
- describeManagedRuleGroupResponse_capacity :: Lens' DescribeManagedRuleGroupResponse (Maybe Natural)
- describeManagedRuleGroupResponse_consumedLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary])
- describeManagedRuleGroupResponse_labelNamespace :: Lens' DescribeManagedRuleGroupResponse (Maybe Text)
- describeManagedRuleGroupResponse_rules :: Lens' DescribeManagedRuleGroupResponse (Maybe [RuleSummary])
- describeManagedRuleGroupResponse_snsTopicArn :: Lens' DescribeManagedRuleGroupResponse (Maybe Text)
- describeManagedRuleGroupResponse_versionName :: Lens' DescribeManagedRuleGroupResponse (Maybe Text)
- describeManagedRuleGroupResponse_httpStatus :: Lens' DescribeManagedRuleGroupResponse Int
Creating a Request
data DescribeManagedRuleGroup Source #
See: newDescribeManagedRuleGroup
smart constructor.
DescribeManagedRuleGroup' | |
|
Instances
newDescribeManagedRuleGroup Source #
:: Text | |
-> Text | |
-> Scope | |
-> DescribeManagedRuleGroup |
Create a value of DescribeManagedRuleGroup
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:
DescribeManagedRuleGroup
, describeManagedRuleGroup_versionName
- The version of the rule group. You can only use a version that is not
scheduled for expiration. If you don't provide this, WAF uses the
vendor's default version.
DescribeManagedRuleGroup
, describeManagedRuleGroup_vendorName
- The name of the managed rule group vendor. You use this, along with the
rule group name, to identify the rule group.
DescribeManagedRuleGroup
, describeManagedRuleGroup_name
- The name of the managed rule group. You use this, along with the vendor
name, to identify the rule group.
DescribeManagedRuleGroup
, describeManagedRuleGroup_scope
- Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load
Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API,
or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. - API and SDKs - For all calls, use the Region endpoint us-east-1.
Request Lenses
describeManagedRuleGroup_versionName :: Lens' DescribeManagedRuleGroup (Maybe Text) Source #
The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.
describeManagedRuleGroup_vendorName :: Lens' DescribeManagedRuleGroup Text Source #
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
describeManagedRuleGroup_name :: Lens' DescribeManagedRuleGroup Text Source #
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
describeManagedRuleGroup_scope :: Lens' DescribeManagedRuleGroup Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. - API and SDKs - For all calls, use the Region endpoint us-east-1.
Destructuring the Response
data DescribeManagedRuleGroupResponse Source #
See: newDescribeManagedRuleGroupResponse
smart constructor.
DescribeManagedRuleGroupResponse' | |
|
Instances
newDescribeManagedRuleGroupResponse Source #
Create a value of DescribeManagedRuleGroupResponse
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:
DescribeManagedRuleGroupResponse
, describeManagedRuleGroupResponse_availableLabels
- The labels that one or more rules in this rule group add to matching web
requests. These labels are defined in the RuleLabels
for a Rule.
DescribeManagedRuleGroupResponse
, describeManagedRuleGroupResponse_capacity
- The web ACL capacity units (WCUs) required for this rule group. WAF uses
web ACL capacity units (WCU) to calculate and control the operating
resources that are used to run your rules, rule groups, and web ACLs.
WAF calculates capacity differently for each rule type, to reflect each
rule's relative cost. Rule group capacity is fixed at creation, so
users can plan their web ACL WCU usage when they use a rule group. The
WCU limit for web ACLs is 1,500.
DescribeManagedRuleGroupResponse
, describeManagedRuleGroupResponse_consumedLabels
- The labels that one or more rules in this rule group match against in
label match statements. These labels are defined in a
LabelMatchStatement
specification, in the Statement definition of a
rule.
DescribeManagedRuleGroupResponse
, describeManagedRuleGroupResponse_labelNamespace
- The label namespace prefix for this rule group. All labels added by
rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>
:When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
DescribeManagedRuleGroupResponse
, describeManagedRuleGroupResponse_rules
-
$sel:snsTopicArn:DescribeManagedRuleGroupResponse'
, describeManagedRuleGroupResponse_snsTopicArn
- The Amazon resource name (ARN) of the Amazon Simple Notification Service
SNS topic that's used to record changes to the managed rule group. You
can subscribe to the SNS topic to receive notifications when the managed
rule group is modified, such as for new versions and for version
expiration. For more information, see the
Amazon Simple Notification Service Developer Guide.
DescribeManagedRuleGroup
, describeManagedRuleGroupResponse_versionName
- The managed rule group's version.
$sel:httpStatus:DescribeManagedRuleGroupResponse'
, describeManagedRuleGroupResponse_httpStatus
- The response's http status code.
Response Lenses
describeManagedRuleGroupResponse_availableLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary]) Source #
The labels that one or more rules in this rule group add to matching web
requests. These labels are defined in the RuleLabels
for a Rule.
describeManagedRuleGroupResponse_capacity :: Lens' DescribeManagedRuleGroupResponse (Maybe Natural) Source #
The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
describeManagedRuleGroupResponse_consumedLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary]) Source #
The labels that one or more rules in this rule group match against in
label match statements. These labels are defined in a
LabelMatchStatement
specification, in the Statement definition of a
rule.
describeManagedRuleGroupResponse_labelNamespace :: Lens' DescribeManagedRuleGroupResponse (Maybe Text) Source #
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>
:When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
describeManagedRuleGroupResponse_rules :: Lens' DescribeManagedRuleGroupResponse (Maybe [RuleSummary]) Source #
describeManagedRuleGroupResponse_snsTopicArn :: Lens' DescribeManagedRuleGroupResponse (Maybe Text) Source #
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
describeManagedRuleGroupResponse_versionName :: Lens' DescribeManagedRuleGroupResponse (Maybe Text) Source #
The managed rule group's version.
describeManagedRuleGroupResponse_httpStatus :: Lens' DescribeManagedRuleGroupResponse Int Source #
The response's http status code.