import * as mod from "https://aws-api.deno.dev/v0.4/services/wafv2.ts?docs=full";
ActionCondition | A single action condition for a "Condition" in a logging filter. |
All | Inspect all of the elements that WAF has parsed and extracted from the web request component that you've identified in your "FieldToMatch" specifications. |
AllowAction | Specifies that WAF should allow the request and optionally defines additional custom handling for the request. |
AllQueryArguments | Inspect all query arguments of the web request. |
AndStatement | A logical rule statement used to combine other rule statements with AND logic.
You provide more than one "Statement" within the |
AssociateWebACLRequest | |
AWSManagedRulesATPRuleSet | Details for your use of the account takeover prevention managed rule group, |
AWSManagedRulesBotControlRuleSet | Details for your use of the Bot Control managed rule group, |
BlockAction | Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request. |
Body | Inspect the body of the web request. The body immediately follows the request headers. |
ByteMatchStatement | A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement. |
CaptchaAction | Specifies that WAF should run a |
CaptchaConfig | Specifies how WAF should handle |
CaptchaResponse | The result from the inspection of the web request for a valid |
ChallengeAction | Specifies that WAF should run a |
ChallengeConfig | Specifies how WAF should handle |
ChallengeResponse | The result from the inspection of the web request for a valid challenge token. |
CheckCapacityRequest | |
CheckCapacityResponse | |
Condition | A single match condition for a "Filter". |
CookieMatchPattern | The filter to use to identify the subset of cookies to inspect in a web request. |
Cookies | Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys. |
CountAction | Specifies that WAF should count the request. Optionally defines additional custom handling for the request. |
CreateIPSetRequest | |
CreateIPSetResponse | |
CreateRegexPatternSetRequest | |
CreateRegexPatternSetResponse | |
CreateRuleGroupRequest | |
CreateRuleGroupResponse | |
CreateWebACLRequest | |
CreateWebACLResponse | |
CustomHTTPHeader | A custom header for custom request and response handling. This is used in "CustomResponse" and "CustomRequestHandling". |
CustomRequestHandling | Custom request handling behavior that inserts custom headers into a web request.
You can add custom request handling for WAF to use when the rule action doesn't block the request.
For example, |
CustomResponse | A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to "BlockAction". |
CustomResponseBody | The response body to use in a custom response to a web request.
This is referenced by key from "CustomResponse" |
DefaultAction | In a "WebACL", this is the action that you want WAF to perform when a web request doesn't match any of the rules in the |
DeleteFirewallManagerRuleGroupsRequest | |
DeleteFirewallManagerRuleGroupsResponse | |
DeleteIPSetRequest | |
DeleteLoggingConfigurationRequest | |
DeletePermissionPolicyRequest | |
DeleteRegexPatternSetRequest | |
DeleteRuleGroupRequest | |
DeleteWebACLRequest | |
DescribeManagedRuleGroupRequest | |
DescribeManagedRuleGroupResponse | |
DisassociateWebACLRequest | |
ExcludedRule | Specifies a single rule in a rule group whose action you want to override to |
FieldToMatch | The part of the web request that you want WAF to inspect.
Include the single |
Filter | A single logging filter, used in "LoggingFilter". |
FirewallManagerRuleGroup | A rule group that's defined for an Firewall Manager WAF policy. |
FirewallManagerStatement | The processing guidance for an Firewall Manager rule. This is like a regular rule "Statement", but it can only contain a rule group reference. |
ForwardedIPConfig | The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. |
GenerateMobileSdkReleaseUrlRequest | |
GenerateMobileSdkReleaseUrlResponse | |
GeoMatchStatement | A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match. |
GetIPSetRequest | |
GetIPSetResponse | |
GetLoggingConfigurationRequest | |
GetLoggingConfigurationResponse | |
GetManagedRuleSetRequest | |
GetManagedRuleSetResponse | |
GetMobileSdkReleaseRequest | |
GetMobileSdkReleaseResponse | |
GetPermissionPolicyRequest | |
GetPermissionPolicyResponse | |
GetRateBasedStatementManagedKeysRequest | |
GetRateBasedStatementManagedKeysResponse | |
GetRegexPatternSetRequest | |
GetRegexPatternSetResponse | |
GetRuleGroupRequest | |
GetRuleGroupResponse | |
GetSampledRequestsRequest | |
GetSampledRequestsResponse | |
GetWebACLForResourceRequest | |
GetWebACLForResourceResponse | |
GetWebACLRequest | |
GetWebACLResponse | |
HeaderMatchPattern | The filter to use to identify the subset of headers to inspect in a web request. |
Headers | Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys. |
HTTPHeader | Part of the response from "GetSampledRequests".
This is a complex type that appears as |
HTTPRequest | Part of the response from "GetSampledRequests".
This is a complex type that appears as |
ImmunityTimeProperty | Used for CAPTCHA and challenge token settings.
Determines how long a |
IPSet | Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. |
IPSetForwardedIPConfig | The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. |
IPSetReferenceStatement | A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an "IPSet" that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see "CreateIPSet". |
IPSetSummary | High-level information about an "IPSet", returned by operations like create and list.
This provides information like the ID, that you can use to retrieve and manage an |
JsonBody | Inspect the body of the web request as JSON. The body immediately follows the request headers. |
JsonMatchPattern | The patterns to look for in the JSON body.
WAF inspects the results of these pattern matches against the rule inspection criteria.
This is used with the "FieldToMatch" option |
Label | A single label container.
This is used as an element of a label array in multiple contexts, for example, in |
LabelMatchStatement | A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL. |
LabelNameCondition | A single label name condition for a "Condition" in a logging filter. |
LabelSummary | List of labels used by one or more of the rules of a "RuleGroup". This summary object is used for the following rule group lists: |
ListAvailableManagedRuleGroupsRequest | |
ListAvailableManagedRuleGroupsResponse | |
ListAvailableManagedRuleGroupVersionsRequest | |
ListAvailableManagedRuleGroupVersionsResponse | |
ListIPSetsRequest | |
ListIPSetsResponse | |
ListLoggingConfigurationsRequest | |
ListLoggingConfigurationsResponse | |
ListManagedRuleSetsRequest | |
ListManagedRuleSetsResponse | |
ListMobileSdkReleasesRequest | |
ListMobileSdkReleasesResponse | |
ListRegexPatternSetsRequest | |
ListRegexPatternSetsResponse | |
ListResourcesForWebACLRequest | |
ListResourcesForWebACLResponse | |
ListRuleGroupsRequest | |
ListRuleGroupsResponse | |
ListTagsForResourceRequest | |
ListTagsForResourceResponse | |
ListWebACLsRequest | |
ListWebACLsResponse | |
LoggingConfiguration | Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records. |
LoggingFilter | Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's "LoggingConfiguration". |
ManagedRuleGroupConfig | Additional information that's used by a managed rule group. Many managed rule groups don't require this. |
ManagedRuleGroupStatement | A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling "ListAvailableManagedRuleGroups". |
ManagedRuleGroupSummary | High-level information about a managed rule group, returned by "ListAvailableManagedRuleGroups". This provides information like the name and vendor name, that you provide when you add a "ManagedRuleGroupStatement" to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Amazon Web Services Marketplace managed rule groups, which you can subscribe to through Amazon Web Services Marketplace. |
ManagedRuleGroupVersion | Describes a single version of a managed rule group. |
ManagedRuleSet | A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF. |
ManagedRuleSetSummary | High-level information for a managed rule set. |
ManagedRuleSetVersion | Information for a single version of a managed rule set. |
Method | Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform. |
MobileSdkRelease | Information for a release of the mobile SDK, including release notes and tags. |
NoneAction | Specifies that WAF should do nothing.
This is used for the |
NotStatement | A logical rule statement used to negate the results of another rule statement.
You provide one "Statement" within the |
OrStatement | A logical rule statement used to combine other rule statements with OR logic.
You provide more than one "Statement" within the |
OverrideAction | The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only. |
PasswordField | Details about your login page password field for request inspection, used in the |
PutLoggingConfigurationRequest | |
PutLoggingConfigurationResponse | |
PutManagedRuleSetVersionsRequest | |
PutManagedRuleSetVersionsResponse | |
PutPermissionPolicyRequest | |
QueryString | Inspect the query string of the web request.
This is the part of a URL that appears after a |
RateBasedStatement | A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests. |
RateBasedStatementManagedKeysIPSet | The set of IP addresses that are currently blocked for a "RateBasedStatement". |
Regex | A single regular expression. This is used in a "RegexPatternSet". |
RegexMatchStatement | A rule statement used to search web request components for a match against a single regular expression. |
RegexPatternSet | Contains one or more regular expressions. |
RegexPatternSetReferenceStatement | A rule statement used to search web request components for matches with regular expressions. To use this, create a "RegexPatternSet" that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see "CreateRegexPatternSet". |
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 |
ReleaseSummary | High level information for an SDK release. |
RequestInspection | The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage. |
ResponseInspection | The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates. |
ResponseInspectionBodyContains | Configures inspection of the response body.
WAF can inspect the first 65,536 bytes (64 KB) of the response body.
This is part of the |
ResponseInspectionHeader | Configures inspection of the response header.
This is part of the |
ResponseInspectionJson | Configures inspection of the response JSON.
WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
This is part of the |
ResponseInspectionStatusCode | Configures inspection of the response status code.
This is part of the |
Rule | A single rule, which you can use in a "WebACL" or "RuleGroup" to identify web requests that you want to allow, block, or count. Each rule includes one top-level "Statement" that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. |
RuleAction | The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. |
RuleActionOverride | Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change. |
RuleGroup | A rule group defines a collection of rules to inspect and control web requests that you can use in a "WebACL". When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. |
RuleGroupReferenceStatement | A rule statement used to run the rules that are defined in a "RuleGroup". To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. |
RuleGroupSummary | 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 |
RuleSummary | High-level information about a "Rule", returned by operations like "DescribeManagedRuleGroup".
This provides information like the ID, that you can use to retrieve and manage a |
SampledHTTPRequest | Represents a single sampled web request.
The response from "GetSampledRequests" includes a |
SingleHeader | Inspect one of the headers in the web request, identified by name, for example, |
SingleQueryArgument | Inspect one query argument in the web request, identified by name, for example UserName or SalesRegion. The name isn't case sensitive. |
SizeConstraintStatement | A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. |
SqliMatchStatement | A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it. |
Statement | The processing guidance for a "Rule", used by WAF to determine whether a web request matches the rule. |
Tag | A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. |
TagInfoForResource | The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. |
TagResourceRequest | |
TextTransformation | Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. |
TimeWindow | In a "GetSampledRequests" request, the |
UntagResourceRequest | |
UpdateIPSetRequest | |
UpdateIPSetResponse | |
UpdateManagedRuleSetVersionExpiryDateRequest | |
UpdateManagedRuleSetVersionExpiryDateResponse | |
UpdateRegexPatternSetRequest | |
UpdateRegexPatternSetResponse | |
UpdateRuleGroupRequest | |
UpdateRuleGroupResponse | |
UpdateWebACLRequest | |
UpdateWebACLResponse | |
UriPath | Inspect the path component of the URI of the web request.
This is the part of the web request that identifies a resource.
For example, |
UsernameField | Details about your login page username field for request inspection, used in the |
VersionToPublish | A version of the named managed rule group, that the rule group's vendor publishes for use by customers. |
VisibilityConfig | Defines and enables Amazon CloudWatch metrics and web request sample collection. |
WebACL | A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types "Rule", "RuleGroup", and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service. |
WebACLSummary | High-level information about a "WebACL", returned by operations like create and list.
This provides information like the ID, that you can use to retrieve and manage a |
XssMatchStatement | A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. |