npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_wafv2

v5.0.0

Published

DataFire integration for AWS WAFV2

Downloads

3

Readme

@datafire/amazonaws_wafv2

Client library for AWS WAFV2

Installation and Usage

npm install --save @datafire/amazonaws_wafv2
let amazonaws_wafv2 = require('@datafire/amazonaws_wafv2').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements. If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces. For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide. AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AWS AppSync GraphQL API responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked. This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide. You can make calls using the endpoints listed in AWS Service Endpoints for AWS WAF. For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API. For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs. We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements: You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL. You can define a Web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL calls. The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.

Actions

AssociateWebACL

amazonaws_wafv2.AssociateWebACL({
  "WebACLArn": null,
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required
    • WebACLArn required

Output

CheckCapacity

amazonaws_wafv2.CheckCapacity({
  "Scope": null,
  "Rules": null
}, context)

Input

  • input object
    • Rules required
    • Scope required

Output

CreateIPSet

amazonaws_wafv2.CreateIPSet({
  "Name": null,
  "Scope": null,
  "IPAddressVersion": null,
  "Addresses": null
}, context)

Input

  • input object
    • Addresses required
    • Description
    • IPAddressVersion required
    • Name required
    • Scope required
    • Tags

Output

CreateRegexPatternSet

amazonaws_wafv2.CreateRegexPatternSet({
  "Name": null,
  "Scope": null,
  "RegularExpressionList": null
}, context)

Input

  • input object
    • Description
    • Name required
    • RegularExpressionList required
    • Scope required
    • Tags

Output

CreateRuleGroup

amazonaws_wafv2.CreateRuleGroup({
  "Name": null,
  "Scope": null,
  "Capacity": null,
  "VisibilityConfig": null
}, context)

Input

  • input object
    • Capacity required
    • Description
    • Name required
    • Rules
    • Scope required
    • Tags
    • VisibilityConfig required
      • CloudWatchMetricsEnabled required
      • MetricName required
      • SampledRequestsEnabled required

Output

CreateWebACL

amazonaws_wafv2.CreateWebACL({
  "Name": null,
  "Scope": null,
  "DefaultAction": null,
  "VisibilityConfig": null
}, context)

Input

  • input object
    • DefaultAction required
      • Allow
      • Block
    • Description
    • Name required
    • Rules
    • Scope required
    • Tags
    • VisibilityConfig required
      • CloudWatchMetricsEnabled required
      • MetricName required
      • SampledRequestsEnabled required

Output

DeleteFirewallManagerRuleGroups

amazonaws_wafv2.DeleteFirewallManagerRuleGroups({
  "WebACLArn": null,
  "WebACLLockToken": null
}, context)

Input

  • input object
    • WebACLArn required
    • WebACLLockToken required

Output

DeleteIPSet

amazonaws_wafv2.DeleteIPSet({
  "Name": null,
  "Scope": null,
  "Id": null,
  "LockToken": null
}, context)

Input

  • input object
    • Id required
    • LockToken required
    • Name required
    • Scope required

Output

DeleteLoggingConfiguration

amazonaws_wafv2.DeleteLoggingConfiguration({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

DeletePermissionPolicy

amazonaws_wafv2.DeletePermissionPolicy({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

DeleteRegexPatternSet

amazonaws_wafv2.DeleteRegexPatternSet({
  "Name": null,
  "Scope": null,
  "Id": null,
  "LockToken": null
}, context)

Input

  • input object
    • Id required
    • LockToken required
    • Name required
    • Scope required

Output

DeleteRuleGroup

amazonaws_wafv2.DeleteRuleGroup({
  "Name": null,
  "Scope": null,
  "Id": null,
  "LockToken": null
}, context)

Input

  • input object
    • Id required
    • LockToken required
    • Name required
    • Scope required

Output

DeleteWebACL

amazonaws_wafv2.DeleteWebACL({
  "Name": null,
  "Scope": null,
  "Id": null,
  "LockToken": null
}, context)

Input

  • input object
    • Id required
    • LockToken required
    • Name required
    • Scope required

Output

DescribeManagedRuleGroup

amazonaws_wafv2.DescribeManagedRuleGroup({
  "VendorName": null,
  "Name": null,
  "Scope": null
}, context)

Input

  • input object
    • Name required
    • Scope required
    • VendorName required

Output

DisassociateWebACL

amazonaws_wafv2.DisassociateWebACL({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

GetIPSet

amazonaws_wafv2.GetIPSet({
  "Name": null,
  "Scope": null,
  "Id": null
}, context)

Input

  • input object
    • Id required
    • Name required
    • Scope required

Output

GetLoggingConfiguration

amazonaws_wafv2.GetLoggingConfiguration({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

GetPermissionPolicy

amazonaws_wafv2.GetPermissionPolicy({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

GetRateBasedStatementManagedKeys

amazonaws_wafv2.GetRateBasedStatementManagedKeys({
  "Scope": null,
  "WebACLName": null,
  "WebACLId": null,
  "RuleName": null
}, context)

Input

  • input object
    • RuleName required
    • Scope required
    • WebACLId required
    • WebACLName required

Output

GetRegexPatternSet

amazonaws_wafv2.GetRegexPatternSet({
  "Name": null,
  "Scope": null,
  "Id": null
}, context)

Input

  • input object
    • Id required
    • Name required
    • Scope required

Output

GetRuleGroup

amazonaws_wafv2.GetRuleGroup({
  "Name": null,
  "Scope": null,
  "Id": null
}, context)

Input

  • input object
    • Id required
    • Name required
    • Scope required

Output

GetSampledRequests

amazonaws_wafv2.GetSampledRequests({
  "WebAclArn": null,
  "RuleMetricName": null,
  "Scope": null,
  "TimeWindow": null,
  "MaxItems": null
}, context)

Input

  • input object
    • MaxItems required
    • RuleMetricName required
    • Scope required
    • TimeWindow required
      • EndTime required
      • StartTime required
    • WebAclArn required

Output

GetWebACL

amazonaws_wafv2.GetWebACL({
  "Name": null,
  "Scope": null,
  "Id": null
}, context)

Input

  • input object
    • Id required
    • Name required
    • Scope required

Output

GetWebACLForResource

amazonaws_wafv2.GetWebACLForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

ListAvailableManagedRuleGroups

amazonaws_wafv2.ListAvailableManagedRuleGroups({
  "Scope": null
}, context)

Input

  • input object
    • Limit
    • NextMarker
    • Scope required

Output

ListIPSets

amazonaws_wafv2.ListIPSets({
  "Scope": null
}, context)

Input

  • input object
    • Limit
    • NextMarker
    • Scope required

Output

ListLoggingConfigurations

amazonaws_wafv2.ListLoggingConfigurations({}, context)

Input

  • input object
    • Limit
    • NextMarker
    • Scope

Output

ListRegexPatternSets

amazonaws_wafv2.ListRegexPatternSets({
  "Scope": null
}, context)

Input

  • input object
    • Limit
    • NextMarker
    • Scope required

Output

ListResourcesForWebACL

amazonaws_wafv2.ListResourcesForWebACL({
  "WebACLArn": null
}, context)

Input

  • input object
    • ResourceType
    • WebACLArn required

Output

ListRuleGroups

amazonaws_wafv2.ListRuleGroups({
  "Scope": null
}, context)

Input

  • input object
    • Limit
    • NextMarker
    • Scope required

Output

ListTagsForResource

amazonaws_wafv2.ListTagsForResource({
  "ResourceARN": null
}, context)

Input

  • input object
    • Limit
    • NextMarker
    • ResourceARN required

Output

ListWebACLs

amazonaws_wafv2.ListWebACLs({
  "Scope": null
}, context)

Input

  • input object
    • Limit
    • NextMarker
    • Scope required

Output

PutLoggingConfiguration

amazonaws_wafv2.PutLoggingConfiguration({
  "LoggingConfiguration": null
}, context)

Input

  • input object
    • LoggingConfiguration required
      • LogDestinationConfigs required
      • ManagedByFirewallManager
      • RedactedFields
      • ResourceArn required

Output

PutPermissionPolicy

amazonaws_wafv2.PutPermissionPolicy({
  "ResourceArn": null,
  "Policy": null
}, context)

Input

  • input object
    • Policy required
    • ResourceArn required

Output

TagResource

amazonaws_wafv2.TagResource({
  "ResourceARN": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceARN required
    • Tags required

Output

UntagResource

amazonaws_wafv2.UntagResource({
  "ResourceARN": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceARN required
    • TagKeys required

Output

UpdateIPSet

amazonaws_wafv2.UpdateIPSet({
  "Name": null,
  "Scope": null,
  "Id": null,
  "Addresses": null,
  "LockToken": null
}, context)

Input

  • input object
    • Addresses required
    • Description
    • Id required
    • LockToken required
    • Name required
    • Scope required

Output

UpdateRegexPatternSet

amazonaws_wafv2.UpdateRegexPatternSet({
  "Name": null,
  "Scope": null,
  "Id": null,
  "RegularExpressionList": null,
  "LockToken": null
}, context)

Input

  • input object
    • Description
    • Id required
    • LockToken required
    • Name required
    • RegularExpressionList required
    • Scope required

Output

UpdateRuleGroup

amazonaws_wafv2.UpdateRuleGroup({
  "Name": null,
  "Scope": null,
  "Id": null,
  "VisibilityConfig": null,
  "LockToken": null
}, context)

Input

  • input object
    • Description
    • Id required
    • LockToken required
    • Name required
    • Rules
    • Scope required
    • VisibilityConfig required
      • CloudWatchMetricsEnabled required
      • MetricName required
      • SampledRequestsEnabled required

Output

UpdateWebACL

amazonaws_wafv2.UpdateWebACL({
  "Name": null,
  "Scope": null,
  "Id": null,
  "DefaultAction": null,
  "VisibilityConfig": null,
  "LockToken": null
}, context)

Input

  • input object
    • DefaultAction required
      • Allow
      • Block
    • Description
    • Id required
    • LockToken required
    • Name required
    • Rules
    • Scope required
    • VisibilityConfig required
      • CloudWatchMetricsEnabled required
      • MetricName required
      • SampledRequestsEnabled required

Output

Definitions

Action

  • Action string

AllQueryArguments

  • AllQueryArguments object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. All query arguments of a web request. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

AllowAction

  • AllowAction object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Specifies that AWS WAF should allow requests. This is used only in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

AndStatement

  • AndStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

AssociateWebACLRequest

  • AssociateWebACLRequest object
    • ResourceArn required
    • WebACLArn required

AssociateWebACLResponse

  • AssociateWebACLResponse object

BlockAction

  • BlockAction object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Specifies that AWS WAF should block requests. This is used only in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

Body

  • Body object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. The body of a web request. This immediately follows the request headers. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

Boolean

  • Boolean boolean

ByteMatchStatement

  • ByteMatchStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
    • FieldToMatch required
      • AllQueryArguments
      • Body
      • Method
      • QueryString
      • SingleHeader
        • Name required
      • SingleQueryArgument
        • Name required
      • UriPath
    • PositionalConstraint required
    • SearchString required
    • TextTransformations required

CapacityUnit

  • CapacityUnit integer

CheckCapacityRequest

  • CheckCapacityRequest object
    • Rules required
    • Scope required

CheckCapacityResponse

  • CheckCapacityResponse object
    • Capacity

ComparisonOperator

  • ComparisonOperator string (values: EQ, NE, LE, LT, GE, GT)

ConsumedCapacity

  • ConsumedCapacity integer

CountAction

  • CountAction object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Specifies that AWS WAF should count requests. This is used only in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

Country

  • Country string

CountryCode

  • CountryCode string (values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW)

CountryCodes

CreateIPSetRequest

  • CreateIPSetRequest object
    • Addresses required
    • Description
    • IPAddressVersion required
    • Name required
    • Scope required
    • Tags

CreateIPSetResponse

  • CreateIPSetResponse object
    • Summary
      • ARN
      • Description
      • Id
      • LockToken
      • Name

CreateRegexPatternSetRequest

  • CreateRegexPatternSetRequest object
    • Description
    • Name required
    • RegularExpressionList required
    • Scope required
    • Tags

CreateRegexPatternSetResponse

  • CreateRegexPatternSetResponse object
    • Summary
      • ARN
      • Description
      • Id
      • LockToken
      • Name

CreateRuleGroupRequest

  • CreateRuleGroupRequest object
    • Capacity required
    • Description
    • Name required
    • Rules
    • Scope required
    • Tags
    • VisibilityConfig required
      • CloudWatchMetricsEnabled required
      • MetricName required
      • SampledRequestsEnabled required

CreateRuleGroupResponse

  • CreateRuleGroupResponse object
    • Summary
      • ARN
      • Description
      • Id
      • LockToken
      • Name

CreateWebACLRequest

  • CreateWebACLRequest object
    • DefaultAction required
      • Allow
      • Block
    • Description
    • Name required
    • Rules
    • Scope required
    • Tags
    • VisibilityConfig required
      • CloudWatchMetricsEnabled required
      • MetricName required
      • SampledRequestsEnabled required

CreateWebACLResponse

  • CreateWebACLResponse object
    • Summary
      • ARN
      • Description
      • Id
      • LockToken
      • Name

DefaultAction

  • DefaultAction object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so count is not allowed.
    • Allow
    • Block

DeleteFirewallManagerRuleGroupsRequest

  • DeleteFirewallManagerRuleGroupsRequest object
    • WebACLArn required
    • WebACLLockToken required

DeleteFirewallManagerRuleGroupsResponse

  • DeleteFirewallManagerRuleGroupsResponse object
    • NextWebACLLockToken

DeleteIPSetRequest

  • DeleteIPSetRequest object
    • Id required
    • LockToken required
    • Name required
    • Scope required

DeleteIPSetResponse

  • DeleteIPSetResponse object

DeleteLoggingConfigurationRequest

  • DeleteLoggingConfigurationRequest object
    • ResourceArn required

DeleteLoggingConfigurationResponse

  • DeleteLoggingConfigurationResponse object

DeletePermissionPolicyRequest

  • DeletePermissionPolicyRequest object
    • ResourceArn required

DeletePermissionPolicyResponse

  • DeletePermissionPolicyResponse object

DeleteRegexPatternSetRequest

  • DeleteRegexPatternSetRequest object
    • Id required
    • LockToken required
    • Name required
    • Scope required

DeleteRegexPatternSetResponse

  • DeleteRegexPatternSetResponse object

DeleteRuleGroupRequest

  • DeleteRuleGroupRequest object
    • Id required
    • LockToken required
    • Name required
    • Scope required

DeleteRuleGroupResponse

  • DeleteRuleGroupResponse object

DeleteWebACLRequest

  • DeleteWebACLRequest object
    • Id required
    • LockToken required
    • Name required
    • Scope required

DeleteWebACLResponse

  • DeleteWebACLResponse object

DescribeManagedRuleGroupRequest

  • DescribeManagedRuleGroupRequest object
    • Name required
    • Scope required
    • VendorName required

DescribeManagedRuleGroupResponse

  • DescribeManagedRuleGroupResponse object

DisassociateWebACLRequest

  • DisassociateWebACLRequest object
    • ResourceArn required

DisassociateWebACLResponse

  • DisassociateWebACLResponse object

EntityDescription

  • EntityDescription string

EntityId

  • EntityId string

EntityName

  • EntityName string

ExcludedRule

  • ExcludedRule object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT. This effectively excludes the rule from acting on web requests.
    • Name required

ExcludedRules

FallbackBehavior

  • FallbackBehavior string (values: MATCH, NO_MATCH)

FieldToMatch

  • FieldToMatch object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. The part of a web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.
    • AllQueryArguments
    • Body
    • Method
    • QueryString
    • SingleHeader
      • Name required
    • SingleQueryArgument
      • Name required
    • UriPath

FieldToMatchData

  • FieldToMatchData string

FirewallManagerRuleGroup

FirewallManagerRuleGroups

FirewallManagerStatement

  • FirewallManagerStatement object: The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

ForwardedIPConfig

  • ForwardedIPConfig object: 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. If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead. AWS WAF only evaluates the first IP address found in the specified HTTP header.
    • FallbackBehavior required
    • HeaderName required

ForwardedIPHeaderName

  • ForwardedIPHeaderName string

ForwardedIPPosition

  • ForwardedIPPosition string (values: FIRST, LAST, ANY)

GeoMatchStatement

  • GeoMatchStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. A rule statement used to identify web requests based on country of origin.
    • CountryCodes
    • ForwardedIPConfig
      • FallbackBehavior required
      • HeaderName required

GetIPSetRequest

  • GetIPSetRequest object
    • Id required
    • Name required
    • Scope required

GetIPSetResponse

  • GetIPSetResponse object
    • IPSet
      • ARN required
      • Addresses required
      • Description
      • IPAddressVersion required
      • Id required
      • Name required
    • LockToken

GetLoggingConfigurationRequest

  • GetLoggingConfigurationRequest object
    • ResourceArn required

GetLoggingConfigurationResponse

  • GetLoggingConfigurationResponse object
    • LoggingConfiguration
      • LogDestinationConfigs required
      • ManagedByFirewallManager
      • RedactedFields
      • ResourceArn required

GetPermissionPolicyRequest

  • GetPermissionPolicyRequest object
    • ResourceArn required

GetPermissionPolicyResponse

  • GetPermissionPolicyResponse object
    • Policy

GetRateBasedStatementManagedKeysRequest

  • GetRateBasedStatementManagedKeysRequest object
    • RuleName required
    • Scope required
    • WebACLId required
    • WebACLName required

GetRateBasedStatementManagedKeysResponse

GetRegexPatternSetRequest

  • GetRegexPatternSetRequest object
    • Id required
    • Name required
    • Scope required

GetRegexPatternSetResponse

  • GetRegexPatternSetResponse object
    • LockToken
    • RegexPatternSet
      • ARN
      • Description
      • Id
      • Name
      • RegularExpressionList

GetRuleGroupRequest

  • GetRuleGroupRequest object
    • Id required
    • Name required
    • Scope required

GetRuleGroupResponse

  • GetRuleGroupResponse object
    • LockToken
    • RuleGroup
      • ARN required
      • Capacity required
      • Description
      • Id required
      • Name required
      • Rules
      • VisibilityConfig required
        • CloudWatchMetricsEnabled required
        • MetricName required
        • SampledRequestsEnabled required

GetSampledRequestsRequest

  • GetSampledRequestsRequest object
    • MaxItems required
    • RuleMetricName required
    • Scope required
    • TimeWindow required
      • EndTime required
      • StartTime required
    • WebAclArn required

GetSampledRequestsResponse

  • GetSampledRequestsResponse object
    • PopulationSize
    • SampledRequests
    • TimeWindow
      • EndTime required
      • StartTime required

GetWebACLForResourceRequest

  • GetWebACLForResourceRequest object
    • ResourceArn required

GetWebACLForResourceResponse

  • GetWebACLForResourceResponse object
    • WebACL
      • ARN required
      • Capacity
      • DefaultAction required
        • Allow
        • Block
      • Description
      • Id required
      • ManagedByFirewallManager
      • Name required
      • PostProcessFirewallManagerRuleGroups
      • PreProcessFirewallManagerRuleGroups
      • Rules
      • VisibilityConfig required
        • CloudWatchMetricsEnabled required
        • MetricName required
        • SampledRequestsEnabled required

GetWebACLRequest

  • GetWebACLRequest object
    • Id required
    • Name required
    • Scope required

GetWebACLResponse

  • GetWebACLResponse object
    • LockToken
    • WebACL
      • ARN required
      • Capacity
      • DefaultAction required
        • Allow
        • Block
      • Description
      • Id required
      • ManagedByFirewallManager
      • Name required
      • PostProcessFirewallManagerRuleGroups
      • PreProcessFirewallManagerRuleGroups
      • Rules
      • VisibilityConfig required
        • CloudWatchMetricsEnabled required
        • MetricName required
        • SampledRequestsEnabled required

HTTPHeader

  • HTTPHeader object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Part of the response from GetSampledRequests. This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests.
    • Name
    • Value

HTTPHeaders

HTTPMethod

  • HTTPMethod string

HTTPRequest

  • HTTPRequest object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests.
    • ClientIP
    • Country
    • HTTPVersion
    • Headers
    • Method
    • URI

HTTPVersion

  • HTTPVersion string

HeaderName

  • HeaderName string

HeaderValue

  • HeaderValue string

IPAddress

  • IPAddress string

IPAddressVersion

  • IPAddressVersion string (values: IPV4, IPV6)

IPAddresses

IPSet

  • IPSet object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports any CIDR range. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
    • ARN required
    • Addresses required
    • Description
    • IPAddressVersion required
    • Id required
    • Name required

IPSetForwardedIPConfig

  • IPSetForwardedIPConfig object: 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. If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
    • FallbackBehavior required
    • HeaderName required
    • Position required

IPSetReferenceStatement

  • IPSetReferenceStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. 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. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
    • ARN required
    • IPSetForwardedIPConfig
      • FallbackBehavior required
      • HeaderName required
      • Position required

IPSetSummaries

IPSetSummary

  • IPSetSummary object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. 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 IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
    • ARN
    • Description
    • Id
    • LockToken
    • Name

IPString

  • IPString string

ListAvailableManagedRuleGroupsRequest

  • ListAvailableManagedRuleGroupsRequest object
    • Limit
    • NextMarker
    • Scope required

ListAvailableManagedRuleGroupsResponse

ListIPSetsRequest

  • ListIPSetsRequest object
    • Limit
    • NextMarker
    • Scope required

ListIPSetsResponse

ListLoggingConfigurationsRequest

  • ListLoggingConfigurationsRequest object
    • Limit
    • NextMarker
    • Scope

ListLoggingConfigurationsResponse

ListMaxItems

  • ListMaxItems integer

ListRegexPatternSetsRequest

  • ListRegexPatternSetsRequest object
    • Limit
    • NextMarker
    • Scope required

ListRegexPatternSetsResponse

ListResourcesForWebACLRequest

  • ListResourcesForWebACLRequest object
    • ResourceType
    • WebACLArn required

ListResourcesForWebACLResponse

  • ListResourcesForWebACLResponse object

ListRuleGroupsRequest

  • ListRuleGroupsRequest object
    • Limit
    • NextMarker
    • Scope required

ListRuleGroupsResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • Limit
    • NextMarker
    • ResourceARN required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • NextMarker
    • TagInfoForResource
      • ResourceARN
      • TagList

ListWebACLsRequest

  • ListWebACLsRequest object
    • Limit
    • NextMarker
    • Scope required

ListWebACLsResponse

LockToken

  • LockToken string

LogDestinationConfigs

LoggingConfiguration

  • LoggingConfiguration object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs.
    • LogDestinationConfigs required
    • ManagedByFirewallManager
    • RedactedFields
    • ResourceArn required

LoggingConfigurations

ManagedRuleGroupStatement

  • ManagedRuleGroupStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. 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. You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    • ExcludedRules
    • Name required
    • VendorName required

ManagedRuleGroupSummaries

ManagedRuleGroupSummary

  • ManagedRuleGroupSummary object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. 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 AWS Managed Rules rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace.
    • Description
    • Name
    • VendorName

Method

  • Method object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

MetricName

  • MetricName string

NextMarker

  • NextMarker string

NoneAction

  • NoneAction object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. Specifies that AWS WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the OverrideAction on the Rule. This is used only in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

NotStatement

  • NotStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
    • Statement required
      • AndStatement
      • ByteMatchStatement
        • FieldToMatch required
          • AllQueryArguments
          • Body
          • Method
          • QueryString
          • SingleHeader
            • Name required
          • SingleQueryArgument
            • Name required
          • UriPath
        • PositionalConstraint required
        • SearchString required
        • TextTransformations required
      • GeoMatchStatement
        • CountryCodes
        • ForwardedIPConfig
          • FallbackBehavior required
          • HeaderName required
      • IPSetReferenceStatement
        • ARN required
        • IPSetForwardedIPConfig
          • FallbackBehavior required
          • HeaderName required
          • Position required
      • ManagedRuleGroupStatement
        • ExcludedRules
        • Name required
        • VendorName required
      • NotStatement
        • Statement required
          • AndStatement
            • Statements required
          • ByteMatchStatement
            • FieldToMatch required
            • PositionalConstraint required
            • SearchString required
            • TextTransformations required
          • GeoMatchStatement
            • CountryCodes
            • ForwardedIPConfig
          • IPSetReferenceStatement
            • ARN required
            • IPSetForwardedIPConfig
          • ManagedRuleGroupStatement
            • ExcludedRules
            • Name required
            • VendorName required
          • NotStatement
            • Statement required
          • OrStatement
            • Statements required
          • RateBasedStatement
            • AggregateKeyType required
            • ForwardedIPConfig
            • Limit required
            • ScopeDownStatement
          • RegexPatternSetReferenceStatement
            • ARN required
            • FieldToMatch required
            • TextTransformations required
          • RuleGroupReferenceStatement
            • ARN required
            • ExcludedRules
          • SizeConstraintStatement
            • ComparisonOperator required
            • FieldToMatch required
            • Size required
            • TextTransformations required
          • SqliMatchStatement
            • FieldToMatch required
            • TextTransformations required
          • XssMatchStatement
            • FieldToMatch required
            • TextTransformations required
      • OrStatement
      • RateBasedStatement
        • AggregateKeyType required
        • ForwardedIPConfig
          • FallbackBehavior required
          • HeaderName required
        • Limit required
        • ScopeDownStatement
          • AndStatement
            • Statements required
          • ByteMatchStatement
            • FieldToMatch required
            • PositionalConstraint required
            • SearchString required
            • TextTransformations required
          • GeoMatchStatement
            • CountryCodes
            • ForwardedIPConfig
          • IPSetReferenceStatement
            • ARN required
            • IPSetForwardedIPConfig
          • ManagedRuleGroupStatement
            • ExcludedRules
            • Name required
            • VendorName required
          • NotStatement
            • Statement required
          • OrStatement
            • Statements required
          • RateBasedStatement
            • AggregateKeyType required
            • ForwardedIPConfig
            • Limit required
            • ScopeDownStatement
          • RegexPatternSetReferenceStatement
            • ARN required
            • FieldToMatch required
            • TextTransformations required
          • RuleGroupReferenceStatement
            • ARN required
            • ExcludedRules
          • SizeConstraintStatement
            • ComparisonOperator required
            • FieldToMatch required
            • Size required
            • TextTransformations required
          • SqliMatchStatement
            • FieldToMatch required
            • TextTransformations required
          • XssMatchStatement
            • FieldToMatch required
            • TextTransformations required
      • RegexPatternSetReferenceStatement
        • ARN required
        • FieldToMatch required
          • AllQueryArguments
          • Body
          • Method
          • QueryString
          • SingleHeader
            • Name required
          • SingleQueryArgument
            • Name required
          • UriPath
        • TextTransformations required
      • RuleGroupReferenceStatement
      • SizeConstraintStatement
        • ComparisonOperator required
        • FieldToMatch required
          • AllQueryArguments
          • Body
          • Method
          • QueryString
          • SingleHeader
            • Name required
          • SingleQueryArgument
            • Name required
          • UriPath
        • Size required
        • TextTransformations required
      • SqliMatchStatement
        • FieldToMatch required
          • AllQueryArguments
          • Body
          • Method
          • QueryString
          • SingleHeader
            • Name required
          • SingleQueryArgument
            • Name required
          • UriPath
        • TextTransformations required
      • XssMatchStatement
        • FieldToMatch required
          • AllQueryArguments
          • Body
          • Method
          • QueryString
          • SingleHeader
            • Name required
          • SingleQueryArgument
            • Name required
          • UriPath
        • TextTransformations required

OrStatement

  • OrStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

OverrideAction

  • OverrideAction object: The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both: If the rule statement references a rule group, use this override action setting and not the action setting. If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
    • Count
    • None

PaginationLimit

  • PaginationLimit integer

PolicyString

  • PolicyString string

PopulationSize

  • PopulationSize integer

PositionalConstraint

  • PositionalConstraint string (values: EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD)

PutLoggingConfigurationRequest

  • PutLoggingConfigurationRequest object
    • LoggingConfiguration required
      • LogDestinationConfigs required
      • ManagedByFirewallManager
      • RedactedFields
      • ResourceArn required

PutLoggingConfigurationResponse

  • PutLoggingConfigurationResponse object
    • LoggingConfiguration
      • LogDestinationConfigs required
      • ManagedByFirewallManager
      • RedactedFields
      • ResourceArn required

PutPermissionPolicyRequest

  • PutPermissionPolicyRequest object
    • Policy required
    • ResourceArn required

PutPermissionPolicyResponse

  • PutPermissionPolicyResponse object

QueryString

  • QueryString object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. The query string of a web request. This is the part of a URL that appears after a ? character, if any. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

RateBasedStatement

  • RateBasedStatement object: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide. 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. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements: An IP match statement with an IP set that specified the address 192.0.2.44. A string match statement that searches in the User-Agent header for the string BadBot. In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule. You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
    • AggregateKeyType required
    • ForwardedIPConfig
      • FallbackBehavior required
      • HeaderName required
    • Limit required
    • ScopeDownStatement
      • AndStatement
      • ByteMatchStatement
        • FieldToMatch required
          • AllQueryArguments
          • Body
          • Method
          • QueryString
          • SingleHeader
            • Name required
          • SingleQueryArgument
            • Name required
          • UriPath
        • PositionalConstraint required
        • SearchString required
        • TextTransformations required
      • GeoMatchStatement
        • CountryCodes
        • ForwardedIPConfig
          • FallbackBehavior required
          • HeaderName required
      • IPSetReferenceStatement
        • ARN required
        • IPSetForwardedIPConfig
          • FallbackBehavior required
          • HeaderName required
          • Position required
      • ManagedRuleGroupStatement
        • ExcludedRules
        • Name required
        • VendorName required
      • NotStatement
        • Statement required
          • AndStatement
            • Statements required
          • ByteMatchStatement
            • FieldToMatch required
            • PositionalConstraint required
            • SearchString required
            • TextTransformations required
          • GeoMatchStatement
            • CountryCodes
            • ForwardedIPConfig
          • IPSetReferenceStatement
            • ARN required
            • IPSetForwardedIPConfig
          • ManagedRuleGroupStatement
            • ExcludedRules
            • Name required
            • VendorName required
          • NotStatement
            • Statement required
          • OrStatement
            • Statements required
          • RateBasedStatement
            • AggregateKeyType required
            • ForwardedIPConfig
            • Limit required
            • ScopeDownStatement
          • RegexPatternSetReferenceStatement
            • ARN required
            • FieldToMatch required
            • TextTransformations required
          • RuleGroupReferenceStatement
            • ARN required
            • ExcludedRules
          • SizeConstraintStatement
            • ComparisonOperator required
            • FieldToMatch required
            • Size required
            • TextTransformations required
          • SqliMatchStatement
            • FieldToMatch required
            • TextTransformations required
          • XssMatchStatement
            • FieldToMatch required
            • TextTransformations required
      • OrStatement
      • RateBasedStatement
        • AggregateKeyType required
        • ForwardedIPConfig
          • FallbackBehavior required
          • HeaderName required
        • Limit required
        • ScopeDownStatement
          • AndStatement
            • Statements required
          • ByteMatchStatement
            • FieldToMatch required
            • PositionalConstraint required
            • SearchString required
            • TextTransformations required
          • GeoMatchStatement
            • CountryCodes
            • ForwardedIPConfig
          • IPSetReferenceStatement
            • ARN required
            • IPSetForwardedIPConfig
          • ManagedRuleGroupStatement
            • ExcludedRules
            • Name required
            • VendorName required
          • NotStatement
            • Statement required
          • OrStatement
            • Statements required
          • RateBasedStatement
            • AggregateKeyType required
            • ForwardedIPConfig
            • Limit required
            • ScopeDownStatement
          • RegexPatternSetReferenceStatement
            • ARN required