| 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.GetRateBasedStatementManagedKeys
Description
Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
Synopsis
- data GetRateBasedStatementManagedKeys = GetRateBasedStatementManagedKeys' {}
- newGetRateBasedStatementManagedKeys :: Scope -> Text -> Text -> Text -> GetRateBasedStatementManagedKeys
- getRateBasedStatementManagedKeys_ruleGroupRuleName :: Lens' GetRateBasedStatementManagedKeys (Maybe Text)
- getRateBasedStatementManagedKeys_scope :: Lens' GetRateBasedStatementManagedKeys Scope
- getRateBasedStatementManagedKeys_webACLName :: Lens' GetRateBasedStatementManagedKeys Text
- getRateBasedStatementManagedKeys_webACLId :: Lens' GetRateBasedStatementManagedKeys Text
- getRateBasedStatementManagedKeys_ruleName :: Lens' GetRateBasedStatementManagedKeys Text
- data GetRateBasedStatementManagedKeysResponse = GetRateBasedStatementManagedKeysResponse' {}
- newGetRateBasedStatementManagedKeysResponse :: Int -> GetRateBasedStatementManagedKeysResponse
- getRateBasedStatementManagedKeysResponse_managedKeysIPV4 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet)
- getRateBasedStatementManagedKeysResponse_managedKeysIPV6 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet)
- getRateBasedStatementManagedKeysResponse_httpStatus :: Lens' GetRateBasedStatementManagedKeysResponse Int
Creating a Request
data GetRateBasedStatementManagedKeys Source #
See: newGetRateBasedStatementManagedKeys smart constructor.
Constructors
| GetRateBasedStatementManagedKeys' | |
Fields
| |
Instances
newGetRateBasedStatementManagedKeys Source #
Arguments
| :: Scope | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> GetRateBasedStatementManagedKeys |
Create a value of GetRateBasedStatementManagedKeys 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:ruleGroupRuleName:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_ruleGroupRuleName - The name of the rule group reference statement in your web ACL. This is
required only when you have the rate-based rule nested inside a rule
group.
GetRateBasedStatementManagedKeys, getRateBasedStatementManagedKeys_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.
$sel:webACLName:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_webACLName - The name of the web ACL. You cannot change the name of a web ACL after
you create it.
$sel:webACLId:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_webACLId - The unique identifier for the web ACL. This ID is returned in the
responses to create and list commands. You provide it to operations like
update and delete.
$sel:ruleName:GetRateBasedStatementManagedKeys', getRateBasedStatementManagedKeys_ruleName - The name of the rate-based rule to get the keys for. If you have the
rule defined inside a rule group that you're using in your web ACL,
also provide the name of the rule group reference statement in the
request parameter RuleGroupRuleName.
Request Lenses
getRateBasedStatementManagedKeys_ruleGroupRuleName :: Lens' GetRateBasedStatementManagedKeys (Maybe Text) Source #
The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.
getRateBasedStatementManagedKeys_scope :: Lens' GetRateBasedStatementManagedKeys 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.
getRateBasedStatementManagedKeys_webACLName :: Lens' GetRateBasedStatementManagedKeys Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
getRateBasedStatementManagedKeys_webACLId :: Lens' GetRateBasedStatementManagedKeys Text Source #
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
getRateBasedStatementManagedKeys_ruleName :: Lens' GetRateBasedStatementManagedKeys Text Source #
The name of the rate-based rule to get the keys for. If you have the
rule defined inside a rule group that you're using in your web ACL,
also provide the name of the rule group reference statement in the
request parameter RuleGroupRuleName.
Destructuring the Response
data GetRateBasedStatementManagedKeysResponse Source #
See: newGetRateBasedStatementManagedKeysResponse smart constructor.
Constructors
| GetRateBasedStatementManagedKeysResponse' | |
Fields
| |
Instances
newGetRateBasedStatementManagedKeysResponse Source #
Arguments
| :: Int | |
| -> GetRateBasedStatementManagedKeysResponse |
Create a value of GetRateBasedStatementManagedKeysResponse 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:managedKeysIPV4:GetRateBasedStatementManagedKeysResponse', getRateBasedStatementManagedKeysResponse_managedKeysIPV4 - The keys that are of Internet Protocol version 4 (IPv4).
$sel:managedKeysIPV6:GetRateBasedStatementManagedKeysResponse', getRateBasedStatementManagedKeysResponse_managedKeysIPV6 - The keys that are of Internet Protocol version 6 (IPv6).
$sel:httpStatus:GetRateBasedStatementManagedKeysResponse', getRateBasedStatementManagedKeysResponse_httpStatus - The response's http status code.
Response Lenses
getRateBasedStatementManagedKeysResponse_managedKeysIPV4 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet) Source #
The keys that are of Internet Protocol version 4 (IPv4).
getRateBasedStatementManagedKeysResponse_managedKeysIPV6 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet) Source #
The keys that are of Internet Protocol version 6 (IPv6).
getRateBasedStatementManagedKeysResponse_httpStatus :: Lens' GetRateBasedStatementManagedKeysResponse Int Source #
The response's http status code.