AWS Native is in preview. AWS Classic is fully supported.
aws-native.wafv2.WebAcl
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Create WebAcl Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WebAcl(name: string, args: WebAclArgs, opts?: CustomResourceOptions);
@overload
def WebAcl(resource_name: str,
args: WebAclArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WebAcl(resource_name: str,
opts: Optional[ResourceOptions] = None,
default_action: Optional[WebAclDefaultActionArgs] = None,
scope: Optional[WebAclScope] = None,
visibility_config: Optional[WebAclVisibilityConfigArgs] = None,
association_config: Optional[WebAclAssociationConfigArgs] = None,
captcha_config: Optional[WebAclCaptchaConfigArgs] = None,
challenge_config: Optional[WebAclChallengeConfigArgs] = None,
custom_response_bodies: Optional[Mapping[str, WebAclCustomResponseBodyArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
rules: Optional[Sequence[WebAclRuleArgs]] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
token_domains: Optional[Sequence[str]] = None)
func NewWebAcl(ctx *Context, name string, args WebAclArgs, opts ...ResourceOption) (*WebAcl, error)
public WebAcl(string name, WebAclArgs args, CustomResourceOptions? opts = null)
public WebAcl(String name, WebAclArgs args)
public WebAcl(String name, WebAclArgs args, CustomResourceOptions options)
type: aws-native:wafv2:WebAcl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WebAclArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WebAclArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WebAclArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WebAclArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WebAclArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
WebAcl Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The WebAcl resource accepts the following input properties:
- Default
Action Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Default Action - The action to perform if none of the
Rules
contained in theWebACL
match. - Scope
Pulumi.
Aws Native. Wa Fv2. Web Acl 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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are
CLOUDFRONT
andREGIONAL
.For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.For information about how to define the association of the web ACL with your resource, see
WebACLAssociation
.- Visibility
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Visibility Config - Defines and enables Amazon CloudWatch metrics and web request sample collection.
- Association
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Association Config Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- Captcha
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
. - Challenge
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Challenge Config - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
. - Custom
Response Dictionary<string, Pulumi.Bodies Aws Native. Wa Fv2. Inputs. Web Acl Custom Response Body Args> A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- Description string
- A description of the web ACL that helps with identification.
- Name string
- The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Rules
List<Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Rule> - Collection of Rules.
- List<Pulumi.
Aws Native. Inputs. Tag> Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
- Token
Domains List<string> - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
- Default
Action WebAcl Default Action Args - The action to perform if none of the
Rules
contained in theWebACL
match. - Scope
Web
Acl 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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are
CLOUDFRONT
andREGIONAL
.For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.For information about how to define the association of the web ACL with your resource, see
WebACLAssociation
.- Visibility
Config WebAcl Visibility Config Args - Defines and enables Amazon CloudWatch metrics and web request sample collection.
- Association
Config WebAcl Association Config Args Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- Captcha
Config WebAcl Captcha Config Args - Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
. - Challenge
Config WebAcl Challenge Config Args - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
. - Custom
Response map[string]WebBodies Acl Custom Response Body Args A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- Description string
- A description of the web ACL that helps with identification.
- Name string
- The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Rules
[]Web
Acl Rule Args - Collection of Rules.
- Tag
Args Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
- Token
Domains []string - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
- default
Action WebAcl Default Action - The action to perform if none of the
Rules
contained in theWebACL
match. - scope
Web
Acl 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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are
CLOUDFRONT
andREGIONAL
.For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.For information about how to define the association of the web ACL with your resource, see
WebACLAssociation
.- visibility
Config WebAcl Visibility Config - Defines and enables Amazon CloudWatch metrics and web request sample collection.
- association
Config WebAcl Association Config Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- captcha
Config WebAcl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
. - challenge
Config WebAcl Challenge Config - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
. - custom
Response Map<String,WebBodies Acl Custom Response Body Args> A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- description String
- A description of the web ACL that helps with identification.
- name String
- The name of the web ACL. You cannot change the name of a web ACL after you create it.
- rules
List<Web
Acl Rule> - Collection of Rules.
- List<Tag>
Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
- token
Domains List<String> - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
- default
Action WebAcl Default Action - The action to perform if none of the
Rules
contained in theWebACL
match. - scope
Web
Acl 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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are
CLOUDFRONT
andREGIONAL
.For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.For information about how to define the association of the web ACL with your resource, see
WebACLAssociation
.- visibility
Config WebAcl Visibility Config - Defines and enables Amazon CloudWatch metrics and web request sample collection.
- association
Config WebAcl Association Config Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- captcha
Config WebAcl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
. - challenge
Config WebAcl Challenge Config - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
. - custom
Response {[key: string]: WebBodies Acl Custom Response Body Args} A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- description string
- A description of the web ACL that helps with identification.
- name string
- The name of the web ACL. You cannot change the name of a web ACL after you create it.
- rules
Web
Acl Rule[] - Collection of Rules.
- Tag[]
Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
- token
Domains string[] - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
- default_
action WebAcl Default Action Args - The action to perform if none of the
Rules
contained in theWebACL
match. - scope
Web
Acl 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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are
CLOUDFRONT
andREGIONAL
.For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.For information about how to define the association of the web ACL with your resource, see
WebACLAssociation
.- visibility_
config WebAcl Visibility Config Args - Defines and enables Amazon CloudWatch metrics and web request sample collection.
- association_
config WebAcl Association Config Args Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- captcha_
config WebAcl Captcha Config Args - Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
. - challenge_
config WebAcl Challenge Config Args - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
. - custom_
response_ Mapping[str, Webbodies Acl Custom Response Body Args] A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- description str
- A description of the web ACL that helps with identification.
- name str
- The name of the web ACL. You cannot change the name of a web ACL after you create it.
- rules
Sequence[Web
Acl Rule Args] - Collection of Rules.
- Sequence[Tag
Args] Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
- token_
domains Sequence[str] - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
- default
Action Property Map - The action to perform if none of the
Rules
contained in theWebACL
match. - scope "CLOUDFRONT" | "REGIONAL"
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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are
CLOUDFRONT
andREGIONAL
.For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.For information about how to define the association of the web ACL with your resource, see
WebACLAssociation
.- visibility
Config Property Map - Defines and enables Amazon CloudWatch metrics and web request sample collection.
- association
Config Property Map Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- captcha
Config Property Map - Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
. - challenge
Config Property Map - Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
. - custom
Response Map<Property Map>Bodies A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- description String
- A description of the web ACL that helps with identification.
- name String
- The name of the web ACL. You cannot change the name of a web ACL after you create it.
- rules List<Property Map>
- Collection of Rules.
- List<Property Map>
Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
- token
Domains List<String> - Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Outputs
All input properties are implicitly available as output properties. Additionally, the WebAcl resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the web ACL.
- Aws
Id string - The ID of the web ACL.
- Capacity int
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
- Id string
- The provider-assigned unique ID for this managed resource.
- Label
Namespace string The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS 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.
- Arn string
- The Amazon Resource Name (ARN) of the web ACL.
- Aws
Id string - The ID of the web ACL.
- Capacity int
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
- Id string
- The provider-assigned unique ID for this managed resource.
- Label
Namespace string The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS 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.
- arn String
- The Amazon Resource Name (ARN) of the web ACL.
- aws
Id String - The ID of the web ACL.
- capacity Integer
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
- id String
- The provider-assigned unique ID for this managed resource.
- label
Namespace String The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS 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.
- arn string
- The Amazon Resource Name (ARN) of the web ACL.
- aws
Id string - The ID of the web ACL.
- capacity number
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
- id string
- The provider-assigned unique ID for this managed resource.
- label
Namespace string The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS 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.
- arn str
- The Amazon Resource Name (ARN) of the web ACL.
- aws_
id str - The ID of the web ACL.
- capacity int
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
- id str
- The provider-assigned unique ID for this managed resource.
- label_
namespace str The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS 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.
- arn String
- The Amazon Resource Name (ARN) of the web ACL.
- aws
Id String - The ID of the web ACL.
- capacity Number
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
- id String
- The provider-assigned unique ID for this managed resource.
- label
Namespace String The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS 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.
Supporting Types
Tag, TagArgs
WebAclAllowAction, WebAclAllowActionArgs
- Custom
Request Pulumi.Handling Aws Native. Wa Fv2. Inputs. Web Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- Custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom_
request_ Webhandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request Property MapHandling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
WebAclAndStatement, WebAclAndStatementArgs
- Statements
List<Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Statement> - The statements to combine with AND logic. You can use any statements that can be nested.
- Statements
[]Web
Acl Statement - The statements to combine with AND logic. You can use any statements that can be nested.
- statements
List<Web
Acl Statement> - The statements to combine with AND logic. You can use any statements that can be nested.
- statements
Web
Acl Statement[] - The statements to combine with AND logic. You can use any statements that can be nested.
- statements
Sequence[Web
Acl Statement] - The statements to combine with AND logic. You can use any statements that can be nested.
- statements List<Property Map>
- The statements to combine with AND logic. You can use any statements that can be nested.
WebAclAssociationConfig, WebAclAssociationConfigArgs
- Request
Body Dictionary<string, Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Request Body Associated Resource Type Config> Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- Request
Body map[string]WebAcl Request Body Associated Resource Type Config Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- request
Body Map<String,WebAcl Request Body Associated Resource Type Config> Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- request
Body {[key: string]: WebAcl Request Body Associated Resource Type Config} Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- request_
body Mapping[str, WebAcl Request Body Associated Resource Type Config] Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- request
Body Map<Property Map> Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing .
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
WebAclAwsManagedRulesAcfpRuleSet, WebAclAwsManagedRulesAcfpRuleSetArgs
- Creation
Path string The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
.- Registration
Page stringPath The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
.- Request
Inspection Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Request Inspection Acfp - The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- Enable
Regex boolIn Path - Allow the use of regular expressions in the registration page path and the account creation path.
- Response
Inspection Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Response Inspection The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
- Creation
Path string The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
.- Registration
Page stringPath The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
.- Request
Inspection WebAcl Request Inspection Acfp - The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- Enable
Regex boolIn Path - Allow the use of regular expressions in the registration page path and the account creation path.
- Response
Inspection WebAcl Response Inspection The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
- creation
Path String The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
.- registration
Page StringPath The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
.- request
Inspection WebAcl Request Inspection Acfp - The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- enable
Regex BooleanIn Path - Allow the use of regular expressions in the registration page path and the account creation path.
- response
Inspection WebAcl Response Inspection The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
- creation
Path string The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
.- registration
Page stringPath The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
.- request
Inspection WebAcl Request Inspection Acfp - The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- enable
Regex booleanIn Path - Allow the use of regular expressions in the registration page path and the account creation path.
- response
Inspection WebAcl Response Inspection The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
- creation_
path str The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
.- registration_
page_ strpath The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
.- request_
inspection WebAcl Request Inspection Acfp - The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- enable_
regex_ boolin_ path - Allow the use of regular expressions in the registration page path and the account creation path.
- response_
inspection WebAcl Response Inspection The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
- creation
Path String The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
.- registration
Page StringPath The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
.- request
Inspection Property Map - The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- enable
Regex BooleanIn Path - Allow the use of regular expressions in the registration page path and the account creation path.
- response
Inspection Property Map The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
WebAclAwsManagedRulesAtpRuleSet, WebAclAwsManagedRulesAtpRuleSetArgs
- Login
Path string The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint.- Enable
Regex boolIn Path - Allow the use of regular expressions in the login page path.
- Request
Inspection Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Request Inspection - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- Response
Inspection Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Response Inspection The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
- Login
Path string The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint.- Enable
Regex boolIn Path - Allow the use of regular expressions in the login page path.
- Request
Inspection WebAcl Request Inspection - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- Response
Inspection WebAcl Response Inspection The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
- login
Path String The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint.- enable
Regex BooleanIn Path - Allow the use of regular expressions in the login page path.
- request
Inspection WebAcl Request Inspection - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- response
Inspection WebAcl Response Inspection The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
- login
Path string The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint.- enable
Regex booleanIn Path - Allow the use of regular expressions in the login page path.
- request
Inspection WebAcl Request Inspection - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- response
Inspection WebAcl Response Inspection The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
- login_
path str The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint.- enable_
regex_ boolin_ path - Allow the use of regular expressions in the login page path.
- request_
inspection WebAcl Request Inspection - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- response_
inspection WebAcl Response Inspection The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
- login
Path String The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint.- enable
Regex BooleanIn Path - Allow the use of regular expressions in the login page path.
- request
Inspection Property Map - The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- response
Inspection Property Map The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
WebAclAwsManagedRulesBotControlRuleSet, WebAclAwsManagedRulesBotControlRuleSetArgs
- Inspection
Level Pulumi.Aws Native. Wa Fv2. Web Acl Aws Managed Rules Bot Control Rule Set Inspection Level - The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see AWS WAF Bot Control rule group in the AWS WAF Developer Guide .
- Enable
Machine boolLearning Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the AWS WAF Developer Guide .
Default:
TRUE
- Inspection
Level WebAcl Aws Managed Rules Bot Control Rule Set Inspection Level - The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see AWS WAF Bot Control rule group in the AWS WAF Developer Guide .
- Enable
Machine boolLearning Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the AWS WAF Developer Guide .
Default:
TRUE
- inspection
Level WebAcl Aws Managed Rules Bot Control Rule Set Inspection Level - The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see AWS WAF Bot Control rule group in the AWS WAF Developer Guide .
- enable
Machine BooleanLearning Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the AWS WAF Developer Guide .
Default:
TRUE
- inspection
Level WebAcl Aws Managed Rules Bot Control Rule Set Inspection Level - The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see AWS WAF Bot Control rule group in the AWS WAF Developer Guide .
- enable
Machine booleanLearning Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the AWS WAF Developer Guide .
Default:
TRUE
- inspection_
level WebAcl Aws Managed Rules Bot Control Rule Set Inspection Level - The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see AWS WAF Bot Control rule group in the AWS WAF Developer Guide .
- enable_
machine_ boollearning Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the AWS WAF Developer Guide .
Default:
TRUE
- inspection
Level "COMMON" | "TARGETED" - The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see AWS WAF Bot Control rule group in the AWS WAF Developer Guide .
- enable
Machine BooleanLearning Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the AWS WAF Developer Guide .
Default:
TRUE
WebAclAwsManagedRulesBotControlRuleSetInspectionLevel, WebAclAwsManagedRulesBotControlRuleSetInspectionLevelArgs
- Common
- COMMON
- Targeted
- TARGETED
- Web
Acl Aws Managed Rules Bot Control Rule Set Inspection Level Common - COMMON
- Web
Acl Aws Managed Rules Bot Control Rule Set Inspection Level Targeted - TARGETED
- Common
- COMMON
- Targeted
- TARGETED
- Common
- COMMON
- Targeted
- TARGETED
- COMMON
- COMMON
- TARGETED
- TARGETED
- "COMMON"
- COMMON
- "TARGETED"
- TARGETED
WebAclBlockAction, WebAclBlockActionArgs
- Custom
Response Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Custom Response Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- Custom
Response WebAcl Custom Response Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Response WebAcl Custom Response Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Response WebAcl Custom Response Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom_
response WebAcl Custom Response Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Response Property Map Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
WebAclBody, WebAclBodyArgs
- Oversize
Handling Pulumi.Aws Native. Wa Fv2. Web Acl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- Oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- oversize_
handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- oversize
Handling "CONTINUE" | "MATCH" | "NO_MATCH" What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
WebAclBodyParsingFallbackBehavior, WebAclBodyParsingFallbackBehaviorArgs
- Match
- MATCH
- No
Match - NO_MATCH
- Evaluate
As String - EVALUATE_AS_STRING
- Web
Acl Body Parsing Fallback Behavior Match - MATCH
- Web
Acl Body Parsing Fallback Behavior No Match - NO_MATCH
- Web
Acl Body Parsing Fallback Behavior Evaluate As String - EVALUATE_AS_STRING
- Match
- MATCH
- No
Match - NO_MATCH
- Evaluate
As String - EVALUATE_AS_STRING
- Match
- MATCH
- No
Match - NO_MATCH
- Evaluate
As String - EVALUATE_AS_STRING
- MATCH
- MATCH
- NO_MATCH
- NO_MATCH
- EVALUATE_AS_STRING
- EVALUATE_AS_STRING
- "MATCH"
- MATCH
- "NO_MATCH"
- NO_MATCH
- "EVALUATE_AS_STRING"
- EVALUATE_AS_STRING
WebAclByteMatchStatement, WebAclByteMatchStatementArgs
- Field
To Pulumi.Match Aws Native. Wa Fv2. Inputs. Web Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Positional
Constraint Pulumi.Aws Native. Wa Fv2. Web Acl Positional Constraint The area within the portion of the web request that you want AWS WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
.SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request.- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - Search
String string A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in
FieldToMatch
. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you provide the stringBadBot
in the value ofSearchString
.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.- Search
String stringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in
SearchString
instead.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.
- Field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Positional
Constraint WebAcl Positional Constraint The area within the portion of the web request that you want AWS WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
.SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request.- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - Search
String string A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in
FieldToMatch
. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you provide the stringBadBot
in the value ofSearchString
.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.- Search
String stringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in
SearchString
instead.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- positional
Constraint WebAcl Positional Constraint The area within the portion of the web request that you want AWS WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
.SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request.- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - search
String String A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in
FieldToMatch
. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you provide the stringBadBot
in the value ofSearchString
.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.- search
String StringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in
SearchString
instead.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- positional
Constraint WebAcl Positional Constraint The area within the portion of the web request that you want AWS WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
.SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request.- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - search
String string A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in
FieldToMatch
. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you provide the stringBadBot
in the value ofSearchString
.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.- search
String stringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in
SearchString
instead.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.
- field_
to_ Webmatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- positional_
constraint WebAcl Positional Constraint The area within the portion of the web request that you want AWS WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
.SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request.- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - search_
string str A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in
FieldToMatch
. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you provide the stringBadBot
in the value ofSearchString
.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.- search_
string_ strbase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in
SearchString
instead.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.
- field
To Property MapMatch - The part of the web request that you want AWS WAF to inspect.
- positional
Constraint "EXACTLY" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "CONTAINS_WORD" The area within the portion of the web request that you want AWS WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
.SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request.- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - search
String String A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in
FieldToMatch
. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you provide the stringBadBot
in the value ofSearchString
.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.- search
String StringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in
SearchString
instead.You must specify either
SearchString
orSearchStringBase64
in aByteMatchStatement
.
WebAclCaptchaAction, WebAclCaptchaActionArgs
- Custom
Request Pulumi.Handling Aws Native. Wa Fv2. Inputs. Web Acl Custom Request Handling Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- Custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom_
request_ Webhandling Acl Custom Request Handling Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request Property MapHandling Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
WebAclCaptchaConfig, WebAclCaptchaConfigArgs
- Immunity
Time Pulumi.Property Aws Native. Wa Fv2. Inputs. Web Acl Immunity Time Property - Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
- Immunity
Time WebProperty Acl Immunity Time Property - Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
- immunity
Time WebProperty Acl Immunity Time Property - Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
- immunity
Time WebProperty Acl Immunity Time Property - Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
- immunity_
time_ Webproperty Acl Immunity Time Property - Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
- immunity
Time Property MapProperty - Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
WebAclChallengeAction, WebAclChallengeActionArgs
- Custom
Request Pulumi.Handling Aws Native. Wa Fv2. Inputs. Web Acl Custom Request Handling Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
- Custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
- custom_
request_ Webhandling Acl Custom Request Handling Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
- custom
Request Property MapHandling Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
WebAclChallengeConfig, WebAclChallengeConfigArgs
- Immunity
Time Pulumi.Property Aws Native. Wa Fv2. Inputs. Web Acl Immunity Time Property - Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
- Immunity
Time WebProperty Acl Immunity Time Property - Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
- immunity
Time WebProperty Acl Immunity Time Property - Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
- immunity
Time WebProperty Acl Immunity Time Property - Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
- immunity_
time_ Webproperty Acl Immunity Time Property - Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
- immunity
Time Property MapProperty - Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
WebAclCookieMatchPattern, WebAclCookieMatchPatternArgs
- All object
- Inspect all parts of the web request cookies.
- List<string>
- Inspect only the cookies whose keys don't match any of the strings specified here.
- List<string>
- Inspect only the cookies that have a key that matches one of the strings specified here.
- All interface{}
- Inspect all parts of the web request cookies.
- []string
- Inspect only the cookies whose keys don't match any of the strings specified here.
- []string
- Inspect only the cookies that have a key that matches one of the strings specified here.
- all Object
- Inspect all parts of the web request cookies.
- List<String>
- Inspect only the cookies whose keys don't match any of the strings specified here.
- List<String>
- Inspect only the cookies that have a key that matches one of the strings specified here.
- all any
- Inspect all parts of the web request cookies.
- string[]
- Inspect only the cookies whose keys don't match any of the strings specified here.
- string[]
- Inspect only the cookies that have a key that matches one of the strings specified here.
- all Any
- Inspect all parts of the web request cookies.
- Sequence[str]
- Inspect only the cookies whose keys don't match any of the strings specified here.
- Sequence[str]
- Inspect only the cookies that have a key that matches one of the strings specified here.
- all Any
- Inspect all parts of the web request cookies.
- List<String>
- Inspect only the cookies whose keys don't match any of the strings specified here.
- List<String>
- Inspect only the cookies that have a key that matches one of the strings specified here.
WebAclCookies, WebAclCookiesArgs
- Match
Pattern Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Cookie Match Pattern The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- Match
Scope Pulumi.Aws Native. Wa Fv2. Web Acl Map Match Scope The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- Oversize
Handling Pulumi.Aws Native. Wa Fv2. Web Acl Oversize Handling What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Match
Pattern WebAcl Cookie Match Pattern The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- Match
Scope WebAcl Map Match Scope The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- Oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match
Pattern WebAcl Cookie Match Pattern The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- match
Scope WebAcl Map Match Scope The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match
Pattern WebAcl Cookie Match Pattern The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- match
Scope WebAcl Map Match Scope The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match_
pattern WebAcl Cookie Match Pattern The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- match_
scope WebAcl Map Match Scope The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize_
handling WebAcl Oversize Handling What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match
Pattern Property Map The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- match
Scope "ALL" | "KEY" | "VALUE" The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize
Handling "CONTINUE" | "MATCH" | "NO_MATCH" What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
WebAclCountAction, WebAclCountActionArgs
- Custom
Request Pulumi.Handling Aws Native. Wa Fv2. Inputs. Web Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- Custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request WebHandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom_
request_ Webhandling Acl Custom Request Handling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
- custom
Request Property MapHandling Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
WebAclCustomHttpHeader, WebAclCustomHttpHeaderArgs
- Name string
The name of the custom header.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, AWS WAF inserts the headerx-amzn-waf-sample
.- Value string
- The value of the custom header.
- Name string
The name of the custom header.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, AWS WAF inserts the headerx-amzn-waf-sample
.- Value string
- The value of the custom header.
- name String
The name of the custom header.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, AWS WAF inserts the headerx-amzn-waf-sample
.- value String
- The value of the custom header.
- name string
The name of the custom header.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, AWS WAF inserts the headerx-amzn-waf-sample
.- value string
- The value of the custom header.
- name str
The name of the custom header.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, AWS WAF inserts the headerx-amzn-waf-sample
.- value str
- The value of the custom header.
- name String
The name of the custom header.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, AWS WAF inserts the headerx-amzn-waf-sample
.- value String
- The value of the custom header.
WebAclCustomRequestHandling, WebAclCustomRequestHandlingArgs
- Insert
Headers List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Custom Http Header> - Collection of HTTP headers.
- Insert
Headers []WebAcl Custom Http Header - Collection of HTTP headers.
- insert
Headers List<WebAcl Custom Http Header> - Collection of HTTP headers.
- insert
Headers WebAcl Custom Http Header[] - Collection of HTTP headers.
- insert_
headers Sequence[WebAcl Custom Http Header] - Collection of HTTP headers.
- insert
Headers List<Property Map> - Collection of HTTP headers.
WebAclCustomResponse, WebAclCustomResponseArgs
- Response
Code int The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .
- Custom
Response stringBody Key - Custom response body key.
- Response
Headers List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Custom Http Header> - Collection of HTTP headers.
- Response
Code int The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .
- Custom
Response stringBody Key - Custom response body key.
- Response
Headers []WebAcl Custom Http Header - Collection of HTTP headers.
- response
Code Integer The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .
- custom
Response StringBody Key - Custom response body key.
- response
Headers List<WebAcl Custom Http Header> - Collection of HTTP headers.
- response
Code number The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .
- custom
Response stringBody Key - Custom response body key.
- response
Headers WebAcl Custom Http Header[] - Collection of HTTP headers.
- response_
code int The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .
- custom_
response_ strbody_ key - Custom response body key.
- response_
headers Sequence[WebAcl Custom Http Header] - Collection of HTTP headers.
- response
Code Number The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .
- custom
Response StringBody Key - Custom response body key.
- response
Headers List<Property Map> - Collection of HTTP headers.
WebAclCustomResponseBody, WebAclCustomResponseBodyArgs
- Content string
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- Content
Type Pulumi.Aws Native. Wa Fv2. Web Acl Response Content Type - The type of content in the payload that you are defining in the
Content
string.
- Content string
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- Content
Type WebAcl Response Content Type - The type of content in the payload that you are defining in the
Content
string.
- content String
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- content
Type WebAcl Response Content Type - The type of content in the payload that you are defining in the
Content
string.
- content string
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- content
Type WebAcl Response Content Type - The type of content in the payload that you are defining in the
Content
string.
- content str
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- content_
type WebAcl Response Content Type - The type of content in the payload that you are defining in the
Content
string.
- content String
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
- content
Type "TEXT_PLAIN" | "TEXT_HTML" | "APPLICATION_JSON" - The type of content in the payload that you are defining in the
Content
string.
WebAclDefaultAction, WebAclDefaultActionArgs
- Allow
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Allow Action - Specifies that AWS WAF should allow requests by default.
- Block
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Block Action - Specifies that AWS WAF should block requests by default.
- Allow
Web
Acl Allow Action - Specifies that AWS WAF should allow requests by default.
- Block
Web
Acl Block Action - Specifies that AWS WAF should block requests by default.
- allow
Web
Acl Allow Action - Specifies that AWS WAF should allow requests by default.
- block
Web
Acl Block Action - Specifies that AWS WAF should block requests by default.
- allow
Web
Acl Allow Action - Specifies that AWS WAF should allow requests by default.
- block
Web
Acl Block Action - Specifies that AWS WAF should block requests by default.
- allow
Web
Acl Allow Action - Specifies that AWS WAF should allow requests by default.
- block
Web
Acl Block Action - Specifies that AWS WAF should block requests by default.
- allow Property Map
- Specifies that AWS WAF should allow requests by default.
- block Property Map
- Specifies that AWS WAF should block requests by default.
WebAclExcludedRule, WebAclExcludedRuleArgs
- Name string
- The name of the rule whose action you want to override to
Count
.
- Name string
- The name of the rule whose action you want to override to
Count
.
- name String
- The name of the rule whose action you want to override to
Count
.
- name string
- The name of the rule whose action you want to override to
Count
.
- name str
- The name of the rule whose action you want to override to
Count
.
- name String
- The name of the rule whose action you want to override to
Count
.
WebAclFieldIdentifier, WebAclFieldIdentifierArgs
- Identifier string
The name of the field.
When the
PayloadType
in the request inspection isJSON
, this identifier must be in JSON pointer syntax. For example/form/username
. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .When the
PayloadType
isFORM_ENCODED
, use the HTML form names. For example,username
.For more information, see the descriptions for each field type in the request inspection properties.
- Identifier string
The name of the field.
When the
PayloadType
in the request inspection isJSON
, this identifier must be in JSON pointer syntax. For example/form/username
. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .When the
PayloadType
isFORM_ENCODED
, use the HTML form names. For example,username
.For more information, see the descriptions for each field type in the request inspection properties.
- identifier String
The name of the field.
When the
PayloadType
in the request inspection isJSON
, this identifier must be in JSON pointer syntax. For example/form/username
. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .When the
PayloadType
isFORM_ENCODED
, use the HTML form names. For example,username
.For more information, see the descriptions for each field type in the request inspection properties.
- identifier string
The name of the field.
When the
PayloadType
in the request inspection isJSON
, this identifier must be in JSON pointer syntax. For example/form/username
. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .When the
PayloadType
isFORM_ENCODED
, use the HTML form names. For example,username
.For more information, see the descriptions for each field type in the request inspection properties.
- identifier str
The name of the field.
When the
PayloadType
in the request inspection isJSON
, this identifier must be in JSON pointer syntax. For example/form/username
. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .When the
PayloadType
isFORM_ENCODED
, use the HTML form names. For example,username
.For more information, see the descriptions for each field type in the request inspection properties.
- identifier String
The name of the field.
When the
PayloadType
in the request inspection isJSON
, this identifier must be in JSON pointer syntax. For example/form/username
. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .When the
PayloadType
isFORM_ENCODED
, use the HTML form names. For example,username
.For more information, see the descriptions for each field type in the request inspection properties.
WebAclFieldToMatch, WebAclFieldToMatchArgs
- All
Query objectArguments - All query arguments of a web request.
- Body
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Body Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration.- Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Cookies Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.- Headers
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Headers Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.- Ja3Fingerprint
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Ja3Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- Json
Body Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Json Body Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration.- Method object
- The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
- Query
String object - The query string of a web request. This is the part of a URL that appears after a ? character, if any.
- Single
Header Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field To Match Single Header Properties Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting.- Single
Query Pulumi.Argument Aws Native. Wa Fv2. Inputs. Web Acl Field To Match Single Query Argument Properties - One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
- Uri
Path object - The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
- All
Query interface{}Arguments - All query arguments of a web request.
- Body
Web
Acl Body Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration.- Web
Acl Cookies Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.- Headers
Web
Acl Headers Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.- Ja3Fingerprint
Web
Acl Ja3Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- Json
Body WebAcl Json Body Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration.- Method interface{}
- The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
- Query
String interface{} - The query string of a web request. This is the part of a URL that appears after a ? character, if any.
- Single
Header WebAcl Field To Match Single Header Properties Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting.- Single
Query WebArgument Acl Field To Match Single Query Argument Properties - One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
- Uri
Path interface{} - The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
- all
Query ObjectArguments - All query arguments of a web request.
- body
Web
Acl Body Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration.- Web
Acl Cookies Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.- headers
Web
Acl Headers Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.- ja3Fingerprint
Web
Acl Ja3Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- json
Body WebAcl Json Body Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration.- method Object
- The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
- query
String Object - The query string of a web request. This is the part of a URL that appears after a ? character, if any.
- single
Header WebAcl Field To Match Single Header Properties Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting.- single
Query WebArgument Acl Field To Match Single Query Argument Properties - One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
- uri
Path Object - The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
- all
Query anyArguments - All query arguments of a web request.
- body
Web
Acl Body Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration.- Web
Acl Cookies Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.- headers
Web
Acl Headers Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.- ja3Fingerprint
Web
Acl Ja3Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- json
Body WebAcl Json Body Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration.- method any
- The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
- query
String any - The query string of a web request. This is the part of a URL that appears after a ? character, if any.
- single
Header WebAcl Field To Match Single Header Properties Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting.- single
Query WebArgument Acl Field To Match Single Query Argument Properties - One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
- uri
Path any - The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
- all_
query_ Anyarguments - All query arguments of a web request.
- body
Web
Acl Body Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration.- Web
Acl Cookies Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.- headers
Web
Acl Headers Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.- ja3_
fingerprint WebAcl Ja3Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- json_
body WebAcl Json Body Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration.- method Any
- The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
- query_
string Any - The query string of a web request. This is the part of a URL that appears after a ? character, if any.
- single_
header WebAcl Field To Match Single Header Properties Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting.- single_
query_ Webargument Acl Field To Match Single Query Argument Properties - One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
- uri_
path Any - The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
- all
Query AnyArguments - All query arguments of a web request.
- body Property Map
Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration.- Property Map
Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.- headers Property Map
Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that AWS WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.- ja3Fingerprint Property Map
Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- json
Body Property Map Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration.- method Any
- The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
- query
String Any - The query string of a web request. This is the part of a URL that appears after a ? character, if any.
- single
Header Property Map Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting.- single
Query Property MapArgument - One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
- uri
Path Any - The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
WebAclFieldToMatchSingleHeaderProperties, WebAclFieldToMatchSingleHeaderPropertiesArgs
- Name string
- Name string
- name String
- name string
- name str
- name String
WebAclFieldToMatchSingleQueryArgumentProperties, WebAclFieldToMatchSingleQueryArgumentPropertiesArgs
- Name string
- Name string
- name String
- name string
- name str
- name String
WebAclForwardedIpConfiguration, WebAclForwardedIpConfigurationArgs
- Fallback
Behavior Pulumi.Aws Native. Wa Fv2. Web Acl Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Header
Name string The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- Fallback
Behavior WebAcl Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Header
Name string The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- fallback
Behavior WebAcl Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header
Name String The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- fallback
Behavior WebAcl Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header
Name string The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- fallback_
behavior WebAcl Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header_
name str The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- fallback
Behavior "MATCH" | "NO_MATCH" The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header
Name String The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
WebAclForwardedIpConfigurationFallbackBehavior, WebAclForwardedIpConfigurationFallbackBehaviorArgs
- Match
- MATCH
- No
Match - NO_MATCH
- Web
Acl Forwarded Ip Configuration Fallback Behavior Match - MATCH
- Web
Acl Forwarded Ip Configuration Fallback Behavior No Match - NO_MATCH
- Match
- MATCH
- No
Match - NO_MATCH
- Match
- MATCH
- No
Match - NO_MATCH
- MATCH
- MATCH
- NO_MATCH
- NO_MATCH
- "MATCH"
- MATCH
- "NO_MATCH"
- NO_MATCH
WebAclGeoMatchStatement, WebAclGeoMatchStatementArgs
- Country
Codes List<string> An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Forwarded
Ip Pulumi.Config Aws Native. Wa Fv2. Inputs. Web Acl Forwarded Ip Configuration 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.
- Country
Codes []string An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Forwarded
Ip WebConfig Acl Forwarded Ip Configuration 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.
- country
Codes List<String> An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- forwarded
Ip WebConfig Acl Forwarded Ip Configuration 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.
- country
Codes string[] An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- forwarded
Ip WebConfig Acl Forwarded Ip Configuration 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.
- country_
codes Sequence[str] An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- forwarded_
ip_ Webconfig Acl Forwarded Ip Configuration 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.
- country
Codes List<String> An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- forwarded
Ip Property MapConfig 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.
WebAclHeaderMatchPattern, WebAclHeaderMatchPatternArgs
- All object
- Inspect all parts of the web request headers.
- Excluded
Headers List<string> - Inspect only the headers whose keys don't match any of the strings specified here.
- Included
Headers List<string> - Inspect only the headers that have a key that matches one of the strings specified here.
- All interface{}
- Inspect all parts of the web request headers.
- Excluded
Headers []string - Inspect only the headers whose keys don't match any of the strings specified here.
- Included
Headers []string - Inspect only the headers that have a key that matches one of the strings specified here.
- all Object
- Inspect all parts of the web request headers.
- excluded
Headers List<String> - Inspect only the headers whose keys don't match any of the strings specified here.
- included
Headers List<String> - Inspect only the headers that have a key that matches one of the strings specified here.
- all any
- Inspect all parts of the web request headers.
- excluded
Headers string[] - Inspect only the headers whose keys don't match any of the strings specified here.
- included
Headers string[] - Inspect only the headers that have a key that matches one of the strings specified here.
- all Any
- Inspect all parts of the web request headers.
- excluded_
headers Sequence[str] - Inspect only the headers whose keys don't match any of the strings specified here.
- included_
headers Sequence[str] - Inspect only the headers that have a key that matches one of the strings specified here.
- all Any
- Inspect all parts of the web request headers.
- excluded
Headers List<String> - Inspect only the headers whose keys don't match any of the strings specified here.
- included
Headers List<String> - Inspect only the headers that have a key that matches one of the strings specified here.
WebAclHeaders, WebAclHeadersArgs
- Match
Pattern Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Header Match Pattern The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- Match
Scope Pulumi.Aws Native. Wa Fv2. Web Acl Map Match Scope The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- Oversize
Handling Pulumi.Aws Native. Wa Fv2. Web Acl Oversize Handling What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Match
Pattern WebAcl Header Match Pattern The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- Match
Scope WebAcl Map Match Scope The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- Oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match
Pattern WebAcl Header Match Pattern The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- match
Scope WebAcl Map Match Scope The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match
Pattern WebAcl Header Match Pattern The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- match
Scope WebAcl Map Match Scope The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match_
pattern WebAcl Header Match Pattern The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- match_
scope WebAcl Map Match Scope The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize_
handling WebAcl Oversize Handling What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- match
Pattern Property Map The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- match
Scope "ALL" | "KEY" | "VALUE" The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, AWS WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- oversize
Handling "CONTINUE" | "MATCH" | "NO_MATCH" What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .
The options for oversize handling are the following:
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
WebAclImmunityTimeProperty, WebAclImmunityTimePropertyArgs
- Immunity
Time int The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by AWS WAF . The default setting is 300.For the Challenge action, the minimum setting is 300.
- Immunity
Time int The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by AWS WAF . The default setting is 300.For the Challenge action, the minimum setting is 300.
- immunity
Time Integer The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by AWS WAF . The default setting is 300.For the Challenge action, the minimum setting is 300.
- immunity
Time number The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by AWS WAF . The default setting is 300.For the Challenge action, the minimum setting is 300.
- immunity_
time int The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by AWS WAF . The default setting is 300.For the Challenge action, the minimum setting is 300.
- immunity
Time Number The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by AWS WAF . The default setting is 300.For the Challenge action, the minimum setting is 300.
WebAclIpSetForwardedIpConfiguration, WebAclIpSetForwardedIpConfigurationArgs
- Fallback
Behavior Pulumi.Aws Native. Wa Fv2. Web Acl Ip Set Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Header
Name string The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- Position
Pulumi.
Aws Native. Wa Fv2. Web Acl Ip Set Forwarded Ip Configuration Position The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
- FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
- LAST - Inspect the last IP address in the list of IP addresses in the header.
- ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
- Fallback
Behavior WebAcl Ip Set Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Header
Name string The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- Position
Web
Acl Ip Set Forwarded Ip Configuration Position The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
- FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
- LAST - Inspect the last IP address in the list of IP addresses in the header.
- ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
- fallback
Behavior WebAcl Ip Set Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header
Name String The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- position
Web
Acl Ip Set Forwarded Ip Configuration Position The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
- FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
- LAST - Inspect the last IP address in the list of IP addresses in the header.
- ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
- fallback
Behavior WebAcl Ip Set Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header
Name string The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- position
Web
Acl Ip Set Forwarded Ip Configuration Position The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
- FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
- LAST - Inspect the last IP address in the list of IP addresses in the header.
- ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
- fallback_
behavior WebAcl Ip Set Forwarded Ip Configuration Fallback Behavior The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header_
name str The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- position
Web
Acl Ip Set Forwarded Ip Configuration Position The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
- FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
- LAST - Inspect the last IP address in the list of IP addresses in the header.
- ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
- fallback
Behavior "MATCH" | "NO_MATCH" The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- header
Name String The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
- position "FIRST" | "LAST" | "ANY"
The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
- FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
- LAST - Inspect the last IP address in the list of IP addresses in the header.
- ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
WebAclIpSetForwardedIpConfigurationFallbackBehavior, WebAclIpSetForwardedIpConfigurationFallbackBehaviorArgs
- Match
- MATCH
- No
Match - NO_MATCH
- Web
Acl Ip Set Forwarded Ip Configuration Fallback Behavior Match - MATCH
- Web
Acl Ip Set Forwarded Ip Configuration Fallback Behavior No Match - NO_MATCH
- Match
- MATCH
- No
Match - NO_MATCH
- Match
- MATCH
- No
Match - NO_MATCH
- MATCH
- MATCH
- NO_MATCH
- NO_MATCH
- "MATCH"
- MATCH
- "NO_MATCH"
- NO_MATCH
WebAclIpSetForwardedIpConfigurationPosition, WebAclIpSetForwardedIpConfigurationPositionArgs
- First
- FIRST
- Last
- LAST
- Any
- ANY
- Web
Acl Ip Set Forwarded Ip Configuration Position First - FIRST
- Web
Acl Ip Set Forwarded Ip Configuration Position Last - LAST
- Web
Acl Ip Set Forwarded Ip Configuration Position Any - ANY
- First
- FIRST
- Last
- LAST
- Any
- ANY
- First
- FIRST
- Last
- LAST
- Any
- ANY
- FIRST
- FIRST
- LAST
- LAST
- ANY
- ANY
- "FIRST"
- FIRST
- "LAST"
- LAST
- "ANY"
- ANY
WebAclIpSetReferenceStatement, WebAclIpSetReferenceStatementArgs
- Arn string
- The Amazon Resource Name (ARN) of the
IPSet
that this statement references. - Ip
Set Pulumi.Forwarded Ip Config Aws Native. Wa Fv2. Inputs. Web Acl Ip Set Forwarded Ip Configuration 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.
- Arn string
- The Amazon Resource Name (ARN) of the
IPSet
that this statement references. - Ip
Set WebForwarded Ip Config Acl Ip Set Forwarded Ip Configuration 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.
- arn String
- The Amazon Resource Name (ARN) of the
IPSet
that this statement references. - ip
Set WebForwarded Ip Config Acl Ip Set Forwarded Ip Configuration 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.
- arn string
- The Amazon Resource Name (ARN) of the
IPSet
that this statement references. - ip
Set WebForwarded Ip Config Acl Ip Set Forwarded Ip Configuration 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.
- arn str
- The Amazon Resource Name (ARN) of the
IPSet
that this statement references. - ip_
set_ Webforwarded_ ip_ config Acl Ip Set Forwarded Ip Configuration 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.
- arn String
- The Amazon Resource Name (ARN) of the
IPSet
that this statement references. - ip
Set Property MapForwarded Ip Config 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.
WebAclJa3Fingerprint, WebAclJa3FingerprintArgs
- Fallback
Behavior Pulumi.Aws Native. Wa Fv2. Web Acl Ja3Fingerprint Fallback Behavior The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- Fallback
Behavior WebAcl Ja3Fingerprint Fallback Behavior The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- fallback
Behavior WebAcl Ja3Fingerprint Fallback Behavior The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- fallback
Behavior WebAcl Ja3Fingerprint Fallback Behavior The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- fallback_
behavior WebAcl Ja3Fingerprint Fallback Behavior The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
- fallback
Behavior "MATCH" | "NO_MATCH" The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
WebAclJa3FingerprintFallbackBehavior, WebAclJa3FingerprintFallbackBehaviorArgs
- Match
- MATCH
- No
Match - NO_MATCH
- Web
Acl Ja3Fingerprint Fallback Behavior Match - MATCH
- Web
Acl Ja3Fingerprint Fallback Behavior No Match - NO_MATCH
- Match
- MATCH
- No
Match - NO_MATCH
- Match
- MATCH
- No
Match - NO_MATCH
- MATCH
- MATCH
- NO_MATCH
- NO_MATCH
- "MATCH"
- MATCH
- "NO_MATCH"
- NO_MATCH
WebAclJsonBody, WebAclJsonBodyArgs
- Match
Pattern Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Json Match Pattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
- Match
Scope Pulumi.Aws Native. Wa Fv2. Web Acl Json Match Scope The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, AWS WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- Invalid
Fallback Pulumi.Behavior Aws Native. Wa Fv2. Web Acl Body Parsing Fallback Behavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
- Missing comma:
{"key1":"value1""key2":"value2"}
- Missing colon:
{"key1":"value1","key2""value2"}
- Extra colons:
{"key1"::"value1","key2""value2"}
- Oversize
Handling Pulumi.Aws Native. Wa Fv2. Web Acl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- Match
Pattern WebAcl Json Match Pattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
- Match
Scope WebAcl Json Match Scope The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, AWS WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- Invalid
Fallback WebBehavior Acl Body Parsing Fallback Behavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
- Missing comma:
{"key1":"value1""key2":"value2"}
- Missing colon:
{"key1":"value1","key2""value2"}
- Extra colons:
{"key1"::"value1","key2""value2"}
- Oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- match
Pattern WebAcl Json Match Pattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
- match
Scope WebAcl Json Match Scope The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, AWS WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- invalid
Fallback WebBehavior Acl Body Parsing Fallback Behavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
- Missing comma:
{"key1":"value1""key2":"value2"}
- Missing colon:
{"key1":"value1","key2""value2"}
- Extra colons:
{"key1"::"value1","key2""value2"}
- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- match
Pattern WebAcl Json Match Pattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
- match
Scope WebAcl Json Match Scope The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, AWS WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- invalid
Fallback WebBehavior Acl Body Parsing Fallback Behavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
- Missing comma:
{"key1":"value1""key2":"value2"}
- Missing colon:
{"key1":"value1","key2""value2"}
- Extra colons:
{"key1"::"value1","key2""value2"}
- oversize
Handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- match_
pattern WebAcl Json Match Pattern - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
- match_
scope WebAcl Json Match Scope The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, AWS WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- invalid_
fallback_ Webbehavior Acl Body Parsing Fallback Behavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
- Missing comma:
{"key1":"value1""key2":"value2"}
- Missing colon:
{"key1":"value1","key2""value2"}
- Extra colons:
{"key1"::"value1","key2""value2"}
- oversize_
handling WebAcl Oversize Handling What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
- match
Pattern Property Map - The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
- match
Scope "ALL" | "KEY" | "VALUE" The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, AWS WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.- invalid
Fallback "MATCH" | "NO_MATCH" | "EVALUATE_AS_STRING"Behavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
- Missing comma:
{"key1":"value1""key2":"value2"}
- Missing colon:
{"key1":"value1","key2""value2"}
- Extra colons:
{"key1"::"value1","key2""value2"}
- oversize
Handling "CONTINUE" | "MATCH" | "NO_MATCH" What AWS WAF should do if the body is larger than AWS WAF can inspect.
AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.
- For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
- For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria.MATCH
- Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
WebAclJsonMatchPattern, WebAclJsonMatchPatternArgs
- All object
- Inspect all parts of the web request's JSON body.
- Included
Paths List<string> Match only the specified include paths. See also
MatchScope
in theJsonBody
FieldToMatch
specification.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
- All interface{}
- Inspect all parts of the web request's JSON body.
- Included
Paths []string Match only the specified include paths. See also
MatchScope
in theJsonBody
FieldToMatch
specification.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
- all Object
- Inspect all parts of the web request's JSON body.
- included
Paths List<String> Match only the specified include paths. See also
MatchScope
in theJsonBody
FieldToMatch
specification.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
- all any
- Inspect all parts of the web request's JSON body.
- included
Paths string[] Match only the specified include paths. See also
MatchScope
in theJsonBody
FieldToMatch
specification.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
- all Any
- Inspect all parts of the web request's JSON body.
- included_
paths Sequence[str] Match only the specified include paths. See also
MatchScope
in theJsonBody
FieldToMatch
specification.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
- all Any
- Inspect all parts of the web request's JSON body.
- included
Paths List<String> Match only the specified include paths. See also
MatchScope
in theJsonBody
FieldToMatch
specification.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
WebAclJsonMatchScope, WebAclJsonMatchScopeArgs
- All
- ALL
- Key
- KEY
- Value
- VALUE
- Web
Acl Json Match Scope All - ALL
- Web
Acl Json Match Scope Key - KEY
- Web
Acl Json Match Scope Value - VALUE
- All
- ALL
- Key
- KEY
- Value
- VALUE
- All
- ALL
- Key
- KEY
- Value
- VALUE
- ALL
- ALL
- KEY
- KEY
- VALUE
- VALUE
- "ALL"
- ALL
- "KEY"
- KEY
- "VALUE"
- VALUE
WebAclLabel, WebAclLabelArgs
- Name string
- The label string.
- Name string
- The label string.
- name String
- The label string.
- name string
- The label string.
- name str
- The label string.
- name String
- The label string.
WebAclLabelMatchScope, WebAclLabelMatchScopeArgs
- Label
- LABEL
- Namespace
- NAMESPACE
- Web
Acl Label Match Scope Label - LABEL
- Web
Acl Label Match Scope Namespace - NAMESPACE
- Label
- LABEL
- Namespace
- NAMESPACE
- Label
- LABEL
- Namespace
- NAMESPACE
- LABEL
- LABEL
- NAMESPACE
- NAMESPACE
- "LABEL"
- LABEL
- "NAMESPACE"
- NAMESPACE
WebAclLabelMatchStatement, WebAclLabelMatchStatementArgs
- Key string
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:- If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. - If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
.- If the
- Scope
Pulumi.
Aws Native. Wa Fv2. Web Acl Label Match Scope - Specify whether you want to match using the label name or just the namespace.
- Key string
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:- If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. - If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
.- If the
- Scope
Web
Acl Label Match Scope - Specify whether you want to match using the label name or just the namespace.
- key String
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:- If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. - If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
.- If the
- scope
Web
Acl Label Match Scope - Specify whether you want to match using the label name or just the namespace.
- key string
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:- If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. - If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
.- If the
- scope
Web
Acl Label Match Scope - Specify whether you want to match using the label name or just the namespace.
- key str
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:- If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. - If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
.- If the
- scope
Web
Acl Label Match Scope - Specify whether you want to match using the label name or just the namespace.
- key String
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:- If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. - If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
.- If the
- scope "LABEL" | "NAMESPACE"
- Specify whether you want to match using the label name or just the namespace.
WebAclManagedRuleGroupConfig, WebAclManagedRuleGroupConfigArgs
- Aws
Managed Pulumi.Rules Acfp Rule Set Aws Native. Wa Fv2. Inputs. Web Acl Aws Managed Rules Acfp Rule Set Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
- Aws
Managed Pulumi.Rules Atp Rule Set Aws Native. Wa Fv2. Inputs. Web Acl Aws Managed Rules Atp Rule Set Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
- Aws
Managed Pulumi.Rules Bot Control Rule Set Aws Native. Wa Fv2. Inputs. Web Acl Aws Managed Rules Bot Control Rule Set - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
- Login
Path string Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.- Password
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- Payload
Type Pulumi.Aws Native. Wa Fv2. Web Acl Managed Rule Group Config Payload Type Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- Username
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
- Aws
Managed WebRules Acfp Rule Set Acl Aws Managed Rules Acfp Rule Set Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
- Aws
Managed WebRules Atp Rule Set Acl Aws Managed Rules Atp Rule Set Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
- Aws
Managed WebRules Bot Control Rule Set Acl Aws Managed Rules Bot Control Rule Set - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
- Login
Path string Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.- Password
Field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- Payload
Type WebAcl Managed Rule Group Config Payload Type Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- Username
Field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
- aws
Managed WebRules Acfp Rule Set Acl Aws Managed Rules Acfp Rule Set Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
- aws
Managed WebRules Atp Rule Set Acl Aws Managed Rules Atp Rule Set Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
- aws
Managed WebRules Bot Control Rule Set Acl Aws Managed Rules Bot Control Rule Set - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
- login
Path String Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.- password
Field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- payload
Type WebAcl Managed Rule Group Config Payload Type Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- username
Field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
- aws
Managed WebRules Acfp Rule Set Acl Aws Managed Rules Acfp Rule Set Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
- aws
Managed WebRules Atp Rule Set Acl Aws Managed Rules Atp Rule Set Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
- aws
Managed WebRules Bot Control Rule Set Acl Aws Managed Rules Bot Control Rule Set - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
- login
Path string Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.- password
Field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- payload
Type WebAcl Managed Rule Group Config Payload Type Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- username
Field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
- aws_
managed_ Webrules_ acfp_ rule_ set Acl Aws Managed Rules Acfp Rule Set Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
- aws_
managed_ Webrules_ atp_ rule_ set Acl Aws Managed Rules Atp Rule Set Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
- aws_
managed_ Webrules_ bot_ control_ rule_ set Acl Aws Managed Rules Bot Control Rule Set - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
- login_
path str Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.- password_
field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- payload_
type WebAcl Managed Rule Group Config Payload Type Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- username_
field WebAcl Field Identifier Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
- aws
Managed Property MapRules Acfp Rule Set Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
- aws
Managed Property MapRules Atp Rule Set Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
- aws
Managed Property MapRules Bot Control Rule Set - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
- login
Path String Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.- password
Field Property Map Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- payload
Type "JSON" | "FORM_ENCODED" Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.- username
Field Property Map Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
WebAclManagedRuleGroupConfigPayloadType, WebAclManagedRuleGroupConfigPayloadTypeArgs
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- Web
Acl Managed Rule Group Config Payload Type Json - JSON
- Web
Acl Managed Rule Group Config Payload Type Form Encoded - FORM_ENCODED
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- JSON
- JSON
- FORM_ENCODED
- FORM_ENCODED
- "JSON"
- JSON
- "FORM_ENCODED"
- FORM_ENCODED
WebAclManagedRuleGroupStatement, WebAclManagedRuleGroupStatementArgs
- Name string
- The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- Vendor
Name string - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- Excluded
Rules List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Excluded Rule> Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- Managed
Rule List<Pulumi.Group Configs Aws Native. Wa Fv2. Inputs. Web Acl Managed Rule Group Config> - Collection of ManagedRuleGroupConfig.
- Rule
Action List<Pulumi.Overrides Aws Native. Wa Fv2. Inputs. Web Acl Rule Action Override> - Action overrides for rules in the rule group.
- Scope
Down Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. - Version string
- The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
- Name string
- The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- Vendor
Name string - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- Excluded
Rules []WebAcl Excluded Rule Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- Managed
Rule []WebGroup Configs Acl Managed Rule Group Config - Collection of ManagedRuleGroupConfig.
- Rule
Action []WebOverrides Acl Rule Action Override - Action overrides for rules in the rule group.
- Scope
Down WebStatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. - Version string
- The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
- name String
- The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- vendor
Name String - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- excluded
Rules List<WebAcl Excluded Rule> Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- managed
Rule List<WebGroup Configs Acl Managed Rule Group Config> - Collection of ManagedRuleGroupConfig.
- rule
Action List<WebOverrides Acl Rule Action Override> - Action overrides for rules in the rule group.
- scope
Down WebStatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. - version String
- The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
- name string
- The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- vendor
Name string - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- excluded
Rules WebAcl Excluded Rule[] Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- managed
Rule WebGroup Configs Acl Managed Rule Group Config[] - Collection of ManagedRuleGroupConfig.
- rule
Action WebOverrides Acl Rule Action Override[] - Action overrides for rules in the rule group.
- scope
Down WebStatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. - version string
- The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
- name str
- The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- vendor_
name str - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- excluded_
rules Sequence[WebAcl Excluded Rule] Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- managed_
rule_ Sequence[Webgroup_ configs Acl Managed Rule Group Config] - Collection of ManagedRuleGroupConfig.
- rule_
action_ Sequence[Weboverrides Acl Rule Action Override] - Action overrides for rules in the rule group.
- scope_
down_ Webstatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. - version str
- The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
- name String
- The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- vendor
Name String - The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- excluded
Rules List<Property Map> Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- managed
Rule List<Property Map>Group Configs - Collection of ManagedRuleGroupConfig.
- rule
Action List<Property Map>Overrides - Action overrides for rules in the rule group.
- scope
Down Property MapStatement - An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. - version String
- The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
WebAclMapMatchScope, WebAclMapMatchScopeArgs
- All
- ALL
- Key
- KEY
- Value
- VALUE
- Web
Acl Map Match Scope All - ALL
- Web
Acl Map Match Scope Key - KEY
- Web
Acl Map Match Scope Value - VALUE
- All
- ALL
- Key
- KEY
- Value
- VALUE
- All
- ALL
- Key
- KEY
- Value
- VALUE
- ALL
- ALL
- KEY
- KEY
- VALUE
- VALUE
- "ALL"
- ALL
- "KEY"
- KEY
- "VALUE"
- VALUE
WebAclNotStatement, WebAclNotStatementArgs
- Statement
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Statement - The statement to negate. You can use any statement that can be nested.
- Statement
Web
Acl Statement - The statement to negate. You can use any statement that can be nested.
- statement
Web
Acl Statement - The statement to negate. You can use any statement that can be nested.
- statement
Web
Acl Statement - The statement to negate. You can use any statement that can be nested.
- statement
Web
Acl Statement - The statement to negate. You can use any statement that can be nested.
- statement Property Map
- The statement to negate. You can use any statement that can be nested.
WebAclOrStatement, WebAclOrStatementArgs
- Statements
List<Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Statement> - The statements to combine with OR logic. You can use any statements that can be nested.
- Statements
[]Web
Acl Statement - The statements to combine with OR logic. You can use any statements that can be nested.
- statements
List<Web
Acl Statement> - The statements to combine with OR logic. You can use any statements that can be nested.
- statements
Web
Acl Statement[] - The statements to combine with OR logic. You can use any statements that can be nested.
- statements
Sequence[Web
Acl Statement] - The statements to combine with OR logic. You can use any statements that can be nested.
- statements List<Property Map>
- The statements to combine with OR logic. You can use any statements that can be nested.
WebAclOverrideAction, WebAclOverrideActionArgs
WebAclOversizeHandling, WebAclOversizeHandlingArgs
- Continue
- CONTINUE
- Match
- MATCH
- No
Match - NO_MATCH
- Web
Acl Oversize Handling Continue - CONTINUE
- Web
Acl Oversize Handling Match - MATCH
- Web
Acl Oversize Handling No Match - NO_MATCH
- Continue
- CONTINUE
- Match
- MATCH
- No
Match - NO_MATCH
- Continue
- CONTINUE
- Match
- MATCH
- No
Match - NO_MATCH
- CONTINUE_
- CONTINUE
- MATCH
- MATCH
- NO_MATCH
- NO_MATCH
- "CONTINUE"
- CONTINUE
- "MATCH"
- MATCH
- "NO_MATCH"
- NO_MATCH
WebAclPositionalConstraint, WebAclPositionalConstraintArgs
- Exactly
- EXACTLY
- Starts
With - STARTS_WITH
- Ends
With - ENDS_WITH
- Contains
- CONTAINS
- Contains
Word - CONTAINS_WORD
- Web
Acl Positional Constraint Exactly - EXACTLY
- Web
Acl Positional Constraint Starts With - STARTS_WITH
- Web
Acl Positional Constraint Ends With - ENDS_WITH
- Web
Acl Positional Constraint Contains - CONTAINS
- Web
Acl Positional Constraint Contains Word - CONTAINS_WORD
- Exactly
- EXACTLY
- Starts
With - STARTS_WITH
- Ends
With - ENDS_WITH
- Contains
- CONTAINS
- Contains
Word - CONTAINS_WORD
- Exactly
- EXACTLY
- Starts
With - STARTS_WITH
- Ends
With - ENDS_WITH
- Contains
- CONTAINS
- Contains
Word - CONTAINS_WORD
- EXACTLY
- EXACTLY
- STARTS_WITH
- STARTS_WITH
- ENDS_WITH
- ENDS_WITH
- CONTAINS
- CONTAINS
- CONTAINS_WORD
- CONTAINS_WORD
- "EXACTLY"
- EXACTLY
- "STARTS_WITH"
- STARTS_WITH
- "ENDS_WITH"
- ENDS_WITH
- "CONTAINS"
- CONTAINS
- "CONTAINS_WORD"
- CONTAINS_WORD
WebAclRateBasedStatement, WebAclRateBasedStatementArgs
- Aggregate
Key Pulumi.Type Aws Native. Wa Fv2. Web Acl Rate Based Statement Aggregate Key Type Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the
ScopeDownStatement
property.CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
.FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
.IP
- Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.- Limit int
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
- If you aggregate on just the IP address, this is the limit on requests from any single IP address.
- If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- Custom
Keys List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Based Statement Custom Key> - Specifies the aggregate keys to use in a rate-base rule.
- Evaluation
Window intSec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes)- Forwarded
Ip Pulumi.Config Aws Native. Wa Fv2. Inputs. Web Acl Forwarded Ip Configuration 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 is required if you specify a forwarded IP in the rule's aggregate key settings.
- Scope
Down Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
- Aggregate
Key WebType Acl Rate Based Statement Aggregate Key Type Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the
ScopeDownStatement
property.CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
.FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
.IP
- Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.- Limit int
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
- If you aggregate on just the IP address, this is the limit on requests from any single IP address.
- If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- Custom
Keys []WebAcl Rate Based Statement Custom Key - Specifies the aggregate keys to use in a rate-base rule.
- Evaluation
Window intSec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes)- Forwarded
Ip WebConfig Acl Forwarded Ip Configuration 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 is required if you specify a forwarded IP in the rule's aggregate key settings.
- Scope
Down WebStatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
- aggregate
Key WebType Acl Rate Based Statement Aggregate Key Type Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the
ScopeDownStatement
property.CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
.FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
.IP
- Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.- limit Integer
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
- If you aggregate on just the IP address, this is the limit on requests from any single IP address.
- If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- custom
Keys List<WebAcl Rate Based Statement Custom Key> - Specifies the aggregate keys to use in a rate-base rule.
- evaluation
Window IntegerSec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes)- forwarded
Ip WebConfig Acl Forwarded Ip Configuration 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 is required if you specify a forwarded IP in the rule's aggregate key settings.
- scope
Down WebStatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
- aggregate
Key WebType Acl Rate Based Statement Aggregate Key Type Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the
ScopeDownStatement
property.CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
.FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
.IP
- Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.- limit number
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
- If you aggregate on just the IP address, this is the limit on requests from any single IP address.
- If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- custom
Keys WebAcl Rate Based Statement Custom Key[] - Specifies the aggregate keys to use in a rate-base rule.
- evaluation
Window numberSec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes)- forwarded
Ip WebConfig Acl Forwarded Ip Configuration 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 is required if you specify a forwarded IP in the rule's aggregate key settings.
- scope
Down WebStatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
- aggregate_
key_ Webtype Acl Rate Based Statement Aggregate Key Type Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the
ScopeDownStatement
property.CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
.FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
.IP
- Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.- limit int
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
- If you aggregate on just the IP address, this is the limit on requests from any single IP address.
- If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- custom_
keys Sequence[WebAcl Rate Based Statement Custom Key] - Specifies the aggregate keys to use in a rate-base rule.
- evaluation_
window_ intsec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes)- forwarded_
ip_ Webconfig Acl Forwarded Ip Configuration 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 is required if you specify a forwarded IP in the rule's aggregate key settings.
- scope_
down_ Webstatement Acl Statement - An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
- aggregate
Key "CONSTANT" | "IP" | "FORWARDED_IP" | "CUSTOM_KEYS"Type Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement.
With this option, you must configure the
ScopeDownStatement
property.CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.
With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
.FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.
With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
.IP
- Aggregate the request counts on the IP address from the web request origin.
To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.- limit Number
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
- If you aggregate on just the IP address, this is the limit on requests from any single IP address.
- If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- custom
Keys List<Property Map> - Specifies the aggregate keys to use in a rate-base rule.
- evaluation
Window NumberSec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes)- forwarded
Ip Property MapConfig 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 is required if you specify a forwarded IP in the rule's aggregate key settings.
- scope
Down Property MapStatement - An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable
Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
WebAclRateBasedStatementAggregateKeyType, WebAclRateBasedStatementAggregateKeyTypeArgs
- Constant
- CONSTANT
- Ip
- IP
- Forwarded
Ip - FORWARDED_IP
- Custom
Keys - CUSTOM_KEYS
- Web
Acl Rate Based Statement Aggregate Key Type Constant - CONSTANT
- Web
Acl Rate Based Statement Aggregate Key Type Ip - IP
- Web
Acl Rate Based Statement Aggregate Key Type Forwarded Ip - FORWARDED_IP
- Web
Acl Rate Based Statement Aggregate Key Type Custom Keys - CUSTOM_KEYS
- Constant
- CONSTANT
- Ip
- IP
- Forwarded
Ip - FORWARDED_IP
- Custom
Keys - CUSTOM_KEYS
- Constant
- CONSTANT
- Ip
- IP
- Forwarded
Ip - FORWARDED_IP
- Custom
Keys - CUSTOM_KEYS
- CONSTANT
- CONSTANT
- IP
- IP
- FORWARDED_IP
- FORWARDED_IP
- CUSTOM_KEYS
- CUSTOM_KEYS
- "CONSTANT"
- CONSTANT
- "IP"
- IP
- "FORWARDED_IP"
- FORWARDED_IP
- "CUSTOM_KEYS"
- CUSTOM_KEYS
WebAclRateBasedStatementCustomKey, WebAclRateBasedStatementCustomKeyArgs
- Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Cookie - Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- Forwarded
Ip Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Forwarded Ip Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property.- Header
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Header - Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- Http
Method Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Http Method - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- Ip
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Ip Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
.- Label
Namespace Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Label Namespace Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .
- Query
Argument Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Query Argument - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- Query
String Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Query String - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- Uri
Path Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Rate Limit Uri Path - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
- Web
Acl Rate Limit Cookie - Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- Forwarded
Ip WebAcl Rate Limit Forwarded Ip Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property.- Header
Web
Acl Rate Limit Header - Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- Http
Method WebAcl Rate Limit Http Method - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- Ip
Web
Acl Rate Limit Ip Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
.- Label
Namespace WebAcl Rate Limit Label Namespace Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .
- Query
Argument WebAcl Rate Limit Query Argument - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- Query
String WebAcl Rate Limit Query String - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- Uri
Path WebAcl Rate Limit Uri Path - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
- Web
Acl Rate Limit Cookie - Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- forwarded
Ip WebAcl Rate Limit Forwarded Ip Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property.- header
Web
Acl Rate Limit Header - Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- http
Method WebAcl Rate Limit Http Method - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- ip
Web
Acl Rate Limit Ip Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
.- label
Namespace WebAcl Rate Limit Label Namespace Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .
- query
Argument WebAcl Rate Limit Query Argument - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- query
String WebAcl Rate Limit Query String - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- uri
Path WebAcl Rate Limit Uri Path - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
- Web
Acl Rate Limit Cookie - Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- forwarded
Ip WebAcl Rate Limit Forwarded Ip Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property.- header
Web
Acl Rate Limit Header - Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- http
Method WebAcl Rate Limit Http Method - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- ip
Web
Acl Rate Limit Ip Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
.- label
Namespace WebAcl Rate Limit Label Namespace Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .
- query
Argument WebAcl Rate Limit Query Argument - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- query
String WebAcl Rate Limit Query String - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- uri
Path WebAcl Rate Limit Uri Path - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
- Web
Acl Rate Limit Cookie - Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- forwarded_
ip WebAcl Rate Limit Forwarded Ip Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property.- header
Web
Acl Rate Limit Header - Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- http_
method WebAcl Rate Limit Http Method - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- ip
Web
Acl Rate Limit Ip Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
.- label_
namespace WebAcl Rate Limit Label Namespace Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .
- query_
argument WebAcl Rate Limit Query Argument - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- query_
string WebAcl Rate Limit Query String - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- uri_
path WebAcl Rate Limit Uri Path - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
- Property Map
- Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- forwarded
Ip Property Map Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property.- header Property Map
- Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- http
Method Property Map - Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- ip Property Map
Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
.- label
Namespace Property Map Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .
- query
Argument Property Map - Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- query
String Property Map - Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- uri
Path Property Map - Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
WebAclRateLimitCookie, WebAclRateLimitCookieArgs
- Name string
- The name of the cookie to use.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- Name string
- The name of the cookie to use.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name String
- The name of the cookie to use.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name string
- The name of the cookie to use.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name str
- The name of the cookie to use.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name String
- The name of the cookie to use.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
WebAclRateLimitHeader, WebAclRateLimitHeaderArgs
- Name string
- The name of the header to use.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- Name string
- The name of the header to use.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name String
- The name of the header to use.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name string
- The name of the header to use.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name str
- The name of the header to use.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name String
- The name of the header to use.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
WebAclRateLimitLabelNamespace, WebAclRateLimitLabelNamespaceArgs
- Namespace string
- The namespace to use for aggregation.
- Namespace string
- The namespace to use for aggregation.
- namespace String
- The namespace to use for aggregation.
- namespace string
- The namespace to use for aggregation.
- namespace str
- The namespace to use for aggregation.
- namespace String
- The namespace to use for aggregation.
WebAclRateLimitQueryArgument, WebAclRateLimitQueryArgumentArgs
- Name string
- The name of the query argument to use.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- Name string
- The name of the query argument to use.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name String
- The name of the query argument to use.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name string
- The name of the query argument to use.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name str
- The name of the query argument to use.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- name String
- The name of the query argument to use.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
WebAclRateLimitQueryString, WebAclRateLimitQueryStringArgs
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
WebAclRateLimitUriPath, WebAclRateLimitUriPathArgs
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
WebAclRegexMatchStatement, WebAclRegexMatchStatementArgs
- Field
To Pulumi.Match Aws Native. Wa Fv2. Inputs. Web Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Regex
String string - The string representing the regular expression.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- Field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Regex
String string - The string representing the regular expression.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- regex
String String - The string representing the regular expression.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- regex
String string - The string representing the regular expression.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field_
to_ Webmatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- regex_
string str - The string representing the regular expression.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field
To Property MapMatch - The part of the web request that you want AWS WAF to inspect.
- regex
String String - The string representing the regular expression.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
WebAclRegexPatternSetReferenceStatement, WebAclRegexPatternSetReferenceStatementArgs
- Arn string
- The Amazon Resource Name (ARN) of the
RegexPatternSet
that this statement references. - Field
To Pulumi.Match Aws Native. Wa Fv2. Inputs. Web Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- Arn string
- The Amazon Resource Name (ARN) of the
RegexPatternSet
that this statement references. - Field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- arn String
- The Amazon Resource Name (ARN) of the
RegexPatternSet
that this statement references. - field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- arn string
- The Amazon Resource Name (ARN) of the
RegexPatternSet
that this statement references. - field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- arn str
- The Amazon Resource Name (ARN) of the
RegexPatternSet
that this statement references. - field_
to_ Webmatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- arn String
- The Amazon Resource Name (ARN) of the
RegexPatternSet
that this statement references. - field
To Property MapMatch - The part of the web request that you want AWS WAF to inspect.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
WebAclRequestBodyAssociatedResourceTypeConfig, WebAclRequestBodyAssociatedResourceTypeConfigArgs
- Default
Size Pulumi.Inspection Limit Aws Native. Wa Fv2. Web Acl Size Inspection Limit Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
- Default
Size WebInspection Limit Acl Size Inspection Limit Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
- default
Size WebInspection Limit Acl Size Inspection Limit Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
- default
Size WebInspection Limit Acl Size Inspection Limit Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
- default_
size_ Webinspection_ limit Acl Size Inspection Limit Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
- default
Size "KB_16" | "KB_32" | "KB_48" | "KB_64"Inspection Limit Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
WebAclRequestInspection, WebAclRequestInspectionArgs
- Password
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- Payload
Type Pulumi.Aws Native. Wa Fv2. Web Acl Request Inspection Payload Type - The payload type for your login endpoint, either JSON or form encoded.
- Username
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- Password
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- Payload
Type WebAcl Request Inspection Payload Type - The payload type for your login endpoint, either JSON or form encoded.
- Username
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- password
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- payload
Type WebAcl Request Inspection Payload Type - The payload type for your login endpoint, either JSON or form encoded.
- username
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- password
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- payload
Type WebAcl Request Inspection Payload Type - The payload type for your login endpoint, either JSON or form encoded.
- username
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- password_
field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- payload_
type WebAcl Request Inspection Payload Type - The payload type for your login endpoint, either JSON or form encoded.
- username_
field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- password
Field Property Map The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- payload
Type "JSON" | "FORM_ENCODED" - The payload type for your login endpoint, either JSON or form encoded.
- username
Field Property Map The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
WebAclRequestInspectionAcfp, WebAclRequestInspectionAcfpArgs
- Payload
Type Pulumi.Aws Native. Wa Fv2. Web Acl Request Inspection Acfp Payload Type - The payload type for your account creation endpoint, either JSON or form encoded.
- Address
Fields List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier> The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.- Email
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.- Password
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- Phone
Number List<Pulumi.Fields Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier> The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.- Username
Field Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- Payload
Type WebAcl Request Inspection Acfp Payload Type - The payload type for your account creation endpoint, either JSON or form encoded.
- Address
Fields []WebAcl Field Identifier The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.- Email
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.- Password
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- Phone
Number []WebFields Acl Field Identifier The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.- Username
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- payload
Type WebAcl Request Inspection Acfp Payload Type - The payload type for your account creation endpoint, either JSON or form encoded.
- address
Fields List<WebAcl Field Identifier> The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.- email
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.- password
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- phone
Number List<WebFields Acl Field Identifier> The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.- username
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- payload
Type WebAcl Request Inspection Acfp Payload Type - The payload type for your account creation endpoint, either JSON or form encoded.
- address
Fields WebAcl Field Identifier[] The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.- email
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.- password
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- phone
Number WebFields Acl Field Identifier[] The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.- username
Field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- payload_
type WebAcl Request Inspection Acfp Payload Type - The payload type for your account creation endpoint, either JSON or form encoded.
- address_
fields Sequence[WebAcl Field Identifier] The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.- email_
field WebAcl Field Identifier The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.- password_
field WebAcl Field Identifier The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- phone_
number_ Sequence[Webfields Acl Field Identifier] The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.- username_
field WebAcl Field Identifier The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
- payload
Type "JSON" | "FORM_ENCODED" - The payload type for your account creation endpoint, either JSON or form encoded.
- address
Fields List<Property Map> The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.- email
Field Property Map The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.- password
Field Property Map The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.- phone
Number List<Property Map>Fields The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
- For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.- username
Field Property Map The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
- For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
.- For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
WebAclRequestInspectionAcfpPayloadType, WebAclRequestInspectionAcfpPayloadTypeArgs
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- Web
Acl Request Inspection Acfp Payload Type Json - JSON
- Web
Acl Request Inspection Acfp Payload Type Form Encoded - FORM_ENCODED
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- JSON
- JSON
- FORM_ENCODED
- FORM_ENCODED
- "JSON"
- JSON
- "FORM_ENCODED"
- FORM_ENCODED
WebAclRequestInspectionPayloadType, WebAclRequestInspectionPayloadTypeArgs
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- Web
Acl Request Inspection Payload Type Json - JSON
- Web
Acl Request Inspection Payload Type Form Encoded - FORM_ENCODED
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- Json
- JSON
- Form
Encoded - FORM_ENCODED
- JSON
- JSON
- FORM_ENCODED
- FORM_ENCODED
- "JSON"
- JSON
- "FORM_ENCODED"
- FORM_ENCODED
WebAclResponseContentType, WebAclResponseContentTypeArgs
- Text
Plain - TEXT_PLAIN
- Text
Html - TEXT_HTML
- Application
Json - APPLICATION_JSON
- Web
Acl Response Content Type Text Plain - TEXT_PLAIN
- Web
Acl Response Content Type Text Html - TEXT_HTML
- Web
Acl Response Content Type Application Json - APPLICATION_JSON
- Text
Plain - TEXT_PLAIN
- Text
Html - TEXT_HTML
- Application
Json - APPLICATION_JSON
- Text
Plain - TEXT_PLAIN
- Text
Html - TEXT_HTML
- Application
Json - APPLICATION_JSON
- TEXT_PLAIN
- TEXT_PLAIN
- TEXT_HTML
- TEXT_HTML
- APPLICATION_JSON
- APPLICATION_JSON
- "TEXT_PLAIN"
- TEXT_PLAIN
- "TEXT_HTML"
- TEXT_HTML
- "APPLICATION_JSON"
- APPLICATION_JSON
WebAclResponseInspection, WebAclResponseInspectionArgs
- Body
Contains Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Response Inspection Body Contains - Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- Header
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Response Inspection Header - Configures inspection of the response header for success and failure indicators.
- Json
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Response Inspection Json - Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- Status
Code Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Response Inspection Status Code - Configures inspection of the response status code for success and failure indicators.
- Body
Contains WebAcl Response Inspection Body Contains - Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- Header
Web
Acl Response Inspection Header - Configures inspection of the response header for success and failure indicators.
- Json
Web
Acl Response Inspection Json - Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- Status
Code WebAcl Response Inspection Status Code - Configures inspection of the response status code for success and failure indicators.
- body
Contains WebAcl Response Inspection Body Contains - Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- header
Web
Acl Response Inspection Header - Configures inspection of the response header for success and failure indicators.
- json
Web
Acl Response Inspection Json - Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- status
Code WebAcl Response Inspection Status Code - Configures inspection of the response status code for success and failure indicators.
- body
Contains WebAcl Response Inspection Body Contains - Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- header
Web
Acl Response Inspection Header - Configures inspection of the response header for success and failure indicators.
- json
Web
Acl Response Inspection Json - Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- status
Code WebAcl Response Inspection Status Code - Configures inspection of the response status code for success and failure indicators.
- body_
contains WebAcl Response Inspection Body Contains - Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- header
Web
Acl Response Inspection Header - Configures inspection of the response header for success and failure indicators.
- json
Web
Acl Response Inspection Json - Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- status_
code WebAcl Response Inspection Status Code - Configures inspection of the response status code for success and failure indicators.
- body
Contains Property Map - Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- header Property Map
- Configures inspection of the response header for success and failure indicators.
- json Property Map
- Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- status
Code Property Map - Configures inspection of the response status code for success and failure indicators.
WebAclResponseInspectionBodyContains, WebAclResponseInspectionBodyContainsArgs
- Failure
Strings List<string> Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- Success
Strings List<string> Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
- Failure
Strings []string Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- Success
Strings []string Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
- failure
Strings List<String> Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- success
Strings List<String> Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
- failure
Strings string[] Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- success
Strings string[] Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
- failure_
strings Sequence[str] Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- success_
strings Sequence[str] Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
- failure
Strings List<String> Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- success
Strings List<String> Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
WebAclResponseInspectionHeader, WebAclResponseInspectionHeaderArgs
- Failure
Values List<string> Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- Name string
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- Success
Values List<string> Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
- Failure
Values []string Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- Name string
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- Success
Values []string Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
- failure
Values List<String> Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- name String
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- success
Values List<String> Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
- failure
Values string[] Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- name string
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- success
Values string[] Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
- failure_
values Sequence[str] Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- name str
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- success_
values Sequence[str] Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
- failure
Values List<String> Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- name String
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- success
Values List<String> Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
WebAclResponseInspectionJson, WebAclResponseInspectionJsonArgs
- Failure
Values List<string> Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- Identifier string
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- Success
Values List<string> Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
- Failure
Values []string Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- Identifier string
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- Success
Values []string Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
- failure
Values List<String> Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- identifier String
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- success
Values List<String> Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
- failure
Values string[] Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- identifier string
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- success
Values string[] Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
- failure_
values Sequence[str] Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- identifier str
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- success_
values Sequence[str] Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
- failure
Values List<String> Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- identifier String
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- success
Values List<String> Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
WebAclResponseInspectionStatusCode, WebAclResponseInspectionStatusCodeArgs
- Failure
Codes List<int> Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- Success
Codes List<int> Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
- Failure
Codes []int Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- Success
Codes []int Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
- failure
Codes List<Integer> Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- success
Codes List<Integer> Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
- failure
Codes number[] Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- success
Codes number[] Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
- failure_
codes Sequence[int] Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- success_
codes Sequence[int] Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
- failure
Codes List<Number> Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- success
Codes List<Number> Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
WebAclRule, WebAclRuleArgs
- Name string
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. AWS WAF doesn't automatically update the metric name when you update the rule name.- Priority int
- If you define more than one
Rule
in aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - Statement
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Statement - The AWS WAF processing statement for the rule, for example
ByteMatchStatement
orSizeConstraintStatement
. - Visibility
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Visibility Config Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.- Action
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Rule Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must set either this
Action
setting or the rule'sOverrideAction
, but not both:- If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
- If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.
- Captcha
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations. If you don't specify this, AWS WAF uses theCAPTCHA
configuration that's defined for the web ACL. - Challenge
Config Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Challenge Config - Specifies how AWS WAF should handle
Challenge
evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL. - Override
Action Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Override Action The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
You must set either this
OverrideAction
setting or theAction
setting, but not both:- If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
- If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.
- Rule
Labels List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Label> - Collection of Rule Labels.
- Name string
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. AWS WAF doesn't automatically update the metric name when you update the rule name.- Priority int
- If you define more than one
Rule
in aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - Statement
Web
Acl Statement - The AWS WAF processing statement for the rule, for example
ByteMatchStatement
orSizeConstraintStatement
. - Visibility
Config WebAcl Visibility Config Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.- Action
Web
Acl Rule Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must set either this
Action
setting or the rule'sOverrideAction
, but not both:- If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
- If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.
- Captcha
Config WebAcl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations. If you don't specify this, AWS WAF uses theCAPTCHA
configuration that's defined for the web ACL. - Challenge
Config WebAcl Challenge Config - Specifies how AWS WAF should handle
Challenge
evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL. - Override
Action WebAcl Override Action The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
You must set either this
OverrideAction
setting or theAction
setting, but not both:- If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
- If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.
- Rule
Labels []WebAcl Label - Collection of Rule Labels.
- name String
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. AWS WAF doesn't automatically update the metric name when you update the rule name.- priority Integer
- If you define more than one
Rule
in aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - statement
Web
Acl Statement - The AWS WAF processing statement for the rule, for example
ByteMatchStatement
orSizeConstraintStatement
. - visibility
Config WebAcl Visibility Config Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.- action
Web
Acl Rule Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must set either this
Action
setting or the rule'sOverrideAction
, but not both:- If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
- If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.
- captcha
Config WebAcl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations. If you don't specify this, AWS WAF uses theCAPTCHA
configuration that's defined for the web ACL. - challenge
Config WebAcl Challenge Config - Specifies how AWS WAF should handle
Challenge
evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL. - override
Action WebAcl Override Action The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
You must set either this
OverrideAction
setting or theAction
setting, but not both:- If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
- If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.
- rule
Labels List<WebAcl Label> - Collection of Rule Labels.
- name string
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. AWS WAF doesn't automatically update the metric name when you update the rule name.- priority number
- If you define more than one
Rule
in aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - statement
Web
Acl Statement - The AWS WAF processing statement for the rule, for example
ByteMatchStatement
orSizeConstraintStatement
. - visibility
Config WebAcl Visibility Config Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.- action
Web
Acl Rule Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must set either this
Action
setting or the rule'sOverrideAction
, but not both:- If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
- If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.
- captcha
Config WebAcl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations. If you don't specify this, AWS WAF uses theCAPTCHA
configuration that's defined for the web ACL. - challenge
Config WebAcl Challenge Config - Specifies how AWS WAF should handle
Challenge
evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL. - override
Action WebAcl Override Action The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
You must set either this
OverrideAction
setting or theAction
setting, but not both:- If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
- If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.
- rule
Labels WebAcl Label[] - Collection of Rule Labels.
- name str
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. AWS WAF doesn't automatically update the metric name when you update the rule name.- priority int
- If you define more than one
Rule
in aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - statement
Web
Acl Statement - The AWS WAF processing statement for the rule, for example
ByteMatchStatement
orSizeConstraintStatement
. - visibility_
config WebAcl Visibility Config Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.- action
Web
Acl Rule Action The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must set either this
Action
setting or the rule'sOverrideAction
, but not both:- If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
- If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.
- captcha_
config WebAcl Captcha Config - Specifies how AWS WAF should handle
CAPTCHA
evaluations. If you don't specify this, AWS WAF uses theCAPTCHA
configuration that's defined for the web ACL. - challenge_
config WebAcl Challenge Config - Specifies how AWS WAF should handle
Challenge
evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL. - override_
action WebAcl Override Action The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
You must set either this
OverrideAction
setting or theAction
setting, but not both:- If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
- If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.
- rule_
labels Sequence[WebAcl Label] - Collection of Rule Labels.
- name String
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. AWS WAF doesn't automatically update the metric name when you update the rule name.- priority Number
- If you define more than one
Rule
in aWebACL
, AWS WAF evaluates each request against theRules
in order based on the value ofPriority
. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - statement Property Map
- The AWS WAF processing statement for the rule, for example
ByteMatchStatement
orSizeConstraintStatement
. - visibility
Config Property Map Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.- action Property Map
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must set either this
Action
setting or the rule'sOverrideAction
, but not both:- If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
- If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.
- captcha
Config Property Map - Specifies how AWS WAF should handle
CAPTCHA
evaluations. If you don't specify this, AWS WAF uses theCAPTCHA
configuration that's defined for the web ACL. - challenge
Config Property Map - Specifies how AWS WAF should handle
Challenge
evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL. - override
Action Property Map The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
You must set either this
OverrideAction
setting or theAction
setting, but not both:- If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
- If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.
- rule
Labels List<Property Map> - Collection of Rule Labels.
WebAclRuleAction, WebAclRuleActionArgs
- Allow
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Allow Action - Instructs AWS WAF to allow the web request.
- Block
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Block Action - Instructs AWS WAF to block the web request.
- Captcha
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Captcha Action Specifies that AWS WAF should run a
CAPTCHA
check against the request:- If the request includes a valid, unexpired
CAPTCHA
token, AWS WAF allows the web request inspection to proceed to the next rule, similar to aCountAction
. - If the request doesn't include a valid, unexpired
CAPTCHA
token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
AWS WAF generates a response that it sends back to the client, which includes the following:
- The header
x-amzn-waf-action
with a value ofcaptcha
. - The HTTP status code
405 Method Not Allowed
. - If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
challenge.
You can configure the expiration time in the
CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.This action option is available for rules. It isn't available for web ACL default actions.
- If the request includes a valid, unexpired
- Challenge
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Challenge Action - Instructs AWS WAF to run a
Challenge
check against the web request. - Count
Pulumi.
Aws Native. Wa Fv2. Inputs. Web Acl Count Action - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
- Allow
Web
Acl Allow Action - Instructs AWS WAF to allow the web request.
- Block
Web
Acl Block Action - Instructs AWS WAF to block the web request.
- Captcha
Web
Acl Captcha Action Specifies that AWS WAF should run a
CAPTCHA
check against the request:- If the request includes a valid, unexpired
CAPTCHA
token, AWS WAF allows the web request inspection to proceed to the next rule, similar to aCountAction
. - If the request doesn't include a valid, unexpired
CAPTCHA
token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
AWS WAF generates a response that it sends back to the client, which includes the following:
- The header
x-amzn-waf-action
with a value ofcaptcha
. - The HTTP status code
405 Method Not Allowed
. - If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
challenge.
You can configure the expiration time in the
CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.This action option is available for rules. It isn't available for web ACL default actions.
- If the request includes a valid, unexpired
- Challenge
Web
Acl Challenge Action - Instructs AWS WAF to run a
Challenge
check against the web request. - Count
Web
Acl Count Action - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
- allow
Web
Acl Allow Action - Instructs AWS WAF to allow the web request.
- block
Web
Acl Block Action - Instructs AWS WAF to block the web request.
- captcha
Web
Acl Captcha Action Specifies that AWS WAF should run a
CAPTCHA
check against the request:- If the request includes a valid, unexpired
CAPTCHA
token, AWS WAF allows the web request inspection to proceed to the next rule, similar to aCountAction
. - If the request doesn't include a valid, unexpired
CAPTCHA
token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
AWS WAF generates a response that it sends back to the client, which includes the following:
- The header
x-amzn-waf-action
with a value ofcaptcha
. - The HTTP status code
405 Method Not Allowed
. - If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
challenge.
You can configure the expiration time in the
CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.This action option is available for rules. It isn't available for web ACL default actions.
- If the request includes a valid, unexpired
- challenge
Web
Acl Challenge Action - Instructs AWS WAF to run a
Challenge
check against the web request. - count
Web
Acl Count Action - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
- allow
Web
Acl Allow Action - Instructs AWS WAF to allow the web request.
- block
Web
Acl Block Action - Instructs AWS WAF to block the web request.
- captcha
Web
Acl Captcha Action Specifies that AWS WAF should run a
CAPTCHA
check against the request:- If the request includes a valid, unexpired
CAPTCHA
token, AWS WAF allows the web request inspection to proceed to the next rule, similar to aCountAction
. - If the request doesn't include a valid, unexpired
CAPTCHA
token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
AWS WAF generates a response that it sends back to the client, which includes the following:
- The header
x-amzn-waf-action
with a value ofcaptcha
. - The HTTP status code
405 Method Not Allowed
. - If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
challenge.
You can configure the expiration time in the
CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.This action option is available for rules. It isn't available for web ACL default actions.
- If the request includes a valid, unexpired
- challenge
Web
Acl Challenge Action - Instructs AWS WAF to run a
Challenge
check against the web request. - count
Web
Acl Count Action - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
- allow
Web
Acl Allow Action - Instructs AWS WAF to allow the web request.
- block
Web
Acl Block Action - Instructs AWS WAF to block the web request.
- captcha
Web
Acl Captcha Action Specifies that AWS WAF should run a
CAPTCHA
check against the request:- If the request includes a valid, unexpired
CAPTCHA
token, AWS WAF allows the web request inspection to proceed to the next rule, similar to aCountAction
. - If the request doesn't include a valid, unexpired
CAPTCHA
token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
AWS WAF generates a response that it sends back to the client, which includes the following:
- The header
x-amzn-waf-action
with a value ofcaptcha
. - The HTTP status code
405 Method Not Allowed
. - If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
challenge.
You can configure the expiration time in the
CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.This action option is available for rules. It isn't available for web ACL default actions.
- If the request includes a valid, unexpired
- challenge
Web
Acl Challenge Action - Instructs AWS WAF to run a
Challenge
check against the web request. - count
Web
Acl Count Action - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
- allow Property Map
- Instructs AWS WAF to allow the web request.
- block Property Map
- Instructs AWS WAF to block the web request.
- captcha Property Map
Specifies that AWS WAF should run a
CAPTCHA
check against the request:- If the request includes a valid, unexpired
CAPTCHA
token, AWS WAF allows the web request inspection to proceed to the next rule, similar to aCountAction
. - If the request doesn't include a valid, unexpired
CAPTCHA
token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
AWS WAF generates a response that it sends back to the client, which includes the following:
- The header
x-amzn-waf-action
with a value ofcaptcha
. - The HTTP status code
405 Method Not Allowed
. - If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
challenge.
You can configure the expiration time in the
CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.This action option is available for rules. It isn't available for web ACL default actions.
- If the request includes a valid, unexpired
- challenge Property Map
- Instructs AWS WAF to run a
Challenge
check against the web request. - count Property Map
- Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
WebAclRuleActionOverride, WebAclRuleActionOverrideArgs
- Action
To Pulumi.Use Aws Native. Wa Fv2. Inputs. Web Acl Rule Action - The override action to use, in place of the configured action of the rule in the rule group.
- Name string
- The name of the rule to override.
- Action
To WebUse Acl Rule Action - The override action to use, in place of the configured action of the rule in the rule group.
- Name string
- The name of the rule to override.
- action
To WebUse Acl Rule Action - The override action to use, in place of the configured action of the rule in the rule group.
- name String
- The name of the rule to override.
- action
To WebUse Acl Rule Action - The override action to use, in place of the configured action of the rule in the rule group.
- name string
- The name of the rule to override.
- action_
to_ Webuse Acl Rule Action - The override action to use, in place of the configured action of the rule in the rule group.
- name str
- The name of the rule to override.
- action
To Property MapUse - The override action to use, in place of the configured action of the rule in the rule group.
- name String
- The name of the rule to override.
WebAclRuleGroupReferenceStatement, WebAclRuleGroupReferenceStatementArgs
- Arn string
- The Amazon Resource Name (ARN) of the entity.
- Excluded
Rules List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Excluded Rule> Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- Rule
Action List<Pulumi.Overrides Aws Native. Wa Fv2. Inputs. Web Acl Rule Action Override> - Action overrides for rules in the rule group.
- Arn string
- The Amazon Resource Name (ARN) of the entity.
- Excluded
Rules []WebAcl Excluded Rule Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- Rule
Action []WebOverrides Acl Rule Action Override - Action overrides for rules in the rule group.
- arn String
- The Amazon Resource Name (ARN) of the entity.
- excluded
Rules List<WebAcl Excluded Rule> Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- rule
Action List<WebOverrides Acl Rule Action Override> - Action overrides for rules in the rule group.
- arn string
- The Amazon Resource Name (ARN) of the entity.
- excluded
Rules WebAcl Excluded Rule[] Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- rule
Action WebOverrides Acl Rule Action Override[] - Action overrides for rules in the rule group.
- arn str
- The Amazon Resource Name (ARN) of the entity.
- excluded_
rules Sequence[WebAcl Excluded Rule] Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- rule_
action_ Sequence[Weboverrides Acl Rule Action Override] - Action overrides for rules in the rule group.
- arn String
- The Amazon Resource Name (ARN) of the entity.
- excluded
Rules List<Property Map> Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
.- rule
Action List<Property Map>Overrides - Action overrides for rules in the rule group.
WebAclScope, WebAclScopeArgs
- Cloudfront
- CLOUDFRONT
- Regional
- REGIONAL
- Web
Acl Scope Cloudfront - CLOUDFRONT
- Web
Acl Scope Regional - REGIONAL
- Cloudfront
- CLOUDFRONT
- Regional
- REGIONAL
- Cloudfront
- CLOUDFRONT
- Regional
- REGIONAL
- CLOUDFRONT
- CLOUDFRONT
- REGIONAL
- REGIONAL
- "CLOUDFRONT"
- CLOUDFRONT
- "REGIONAL"
- REGIONAL
WebAclSensitivityLevel, WebAclSensitivityLevelArgs
- Low
- LOW
- High
- HIGH
- Web
Acl Sensitivity Level Low - LOW
- Web
Acl Sensitivity Level High - HIGH
- Low
- LOW
- High
- HIGH
- Low
- LOW
- High
- HIGH
- LOW
- LOW
- HIGH
- HIGH
- "LOW"
- LOW
- "HIGH"
- HIGH
WebAclSizeConstraintStatement, WebAclSizeConstraintStatementArgs
- Comparison
Operator Pulumi.Aws Native. Wa Fv2. Web Acl Size Constraint Statement Comparison Operator - The operator to use to compare the request part to the size setting.
- Field
To Pulumi.Match Aws Native. Wa Fv2. Inputs. Web Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Size double
- The size, in byte, to compare to the request part, after any transformations.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- Comparison
Operator WebAcl Size Constraint Statement Comparison Operator - The operator to use to compare the request part to the size setting.
- Field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Size float64
- The size, in byte, to compare to the request part, after any transformations.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- comparison
Operator WebAcl Size Constraint Statement Comparison Operator - The operator to use to compare the request part to the size setting.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- size Double
- The size, in byte, to compare to the request part, after any transformations.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- comparison
Operator WebAcl Size Constraint Statement Comparison Operator - The operator to use to compare the request part to the size setting.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- size number
- The size, in byte, to compare to the request part, after any transformations.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- comparison_
operator WebAcl Size Constraint Statement Comparison Operator - The operator to use to compare the request part to the size setting.
- field_
to_ Webmatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- size float
- The size, in byte, to compare to the request part, after any transformations.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- comparison
Operator "EQ" | "NE" | "LE" | "LT" | "GE" | "GT" - The operator to use to compare the request part to the size setting.
- field
To Property MapMatch - The part of the web request that you want AWS WAF to inspect.
- size Number
- The size, in byte, to compare to the request part, after any transformations.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
WebAclSizeConstraintStatementComparisonOperator, WebAclSizeConstraintStatementComparisonOperatorArgs
- Eq
- EQ
- Ne
- NE
- Le
- LE
- Lt
- LT
- Ge
- GE
- Gt
- GT
- Web
Acl Size Constraint Statement Comparison Operator Eq - EQ
- Web
Acl Size Constraint Statement Comparison Operator Ne - NE
- Web
Acl Size Constraint Statement Comparison Operator Le - LE
- Web
Acl Size Constraint Statement Comparison Operator Lt - LT
- Web
Acl Size Constraint Statement Comparison Operator Ge - GE
- Web
Acl Size Constraint Statement Comparison Operator Gt - GT
- Eq
- EQ
- Ne
- NE
- Le
- LE
- Lt
- LT
- Ge
- GE
- Gt
- GT
- Eq
- EQ
- Ne
- NE
- Le
- LE
- Lt
- LT
- Ge
- GE
- Gt
- GT
- EQ
- EQ
- NE
- NE
- LE
- LE
- LT
- LT
- GE
- GE
- GT
- GT
- "EQ"
- EQ
- "NE"
- NE
- "LE"
- LE
- "LT"
- LT
- "GE"
- GE
- "GT"
- GT
WebAclSizeInspectionLimit, WebAclSizeInspectionLimitArgs
- Kb16
- KB_16
- Kb32
- KB_32
- Kb48
- KB_48
- Kb64
- KB_64
- Web
Acl Size Inspection Limit Kb16 - KB_16
- Web
Acl Size Inspection Limit Kb32 - KB_32
- Web
Acl Size Inspection Limit Kb48 - KB_48
- Web
Acl Size Inspection Limit Kb64 - KB_64
- Kb16
- KB_16
- Kb32
- KB_32
- Kb48
- KB_48
- Kb64
- KB_64
- Kb16
- KB_16
- Kb32
- KB_32
- Kb48
- KB_48
- Kb64
- KB_64
- KB16
- KB_16
- KB32
- KB_32
- KB48
- KB_48
- KB64
- KB_64
- "KB_16"
- KB_16
- "KB_32"
- KB_32
- "KB_48"
- KB_48
- "KB_64"
- KB_64
WebAclSqliMatchStatement, WebAclSqliMatchStatementArgs
- Field
To Pulumi.Match Aws Native. Wa Fv2. Inputs. Web Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - Sensitivity
Level Pulumi.Aws Native. Wa Fv2. Web Acl Sensitivity Level The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide .LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
- Field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - Sensitivity
Level WebAcl Sensitivity Level The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide .LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - sensitivity
Level WebAcl Sensitivity Level The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide .LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - sensitivity
Level WebAcl Sensitivity Level The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide .LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
- field_
to_ Webmatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - sensitivity_
level WebAcl Sensitivity Level The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide .LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
- field
To Property MapMatch - The part of the web request that you want AWS WAF to inspect.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match. - sensitivity
Level "LOW" | "HIGH" The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide .LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
WebAclStatement, WebAclStatementArgs
- And
Statement Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl And Statement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement
within theAndStatement
. - Byte
Match Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Byte Match Statement - 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 called a string match statement.
- Geo
Match Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Geo Match Statement 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.
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the AWS WAF Developer Guide .
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
- Ip
Set Pulumi.Reference Statement Aws Native. Wa Fv2. Inputs. Web Acl Ip Set Reference Statement 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.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.
- Label
Match Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Label Match Statement 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.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
- Managed
Rule Pulumi.Group Statement Aws Native. Wa Fv2. Inputs. Web Acl Managed Rule Group Statement 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 through the API call
ListAvailableManagedRuleGroups
.You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. It can only be referenced as a top-level statement within a rule.You are charged additional fees when you use the AWS WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see AWS WAF Pricing .- Not
Statement Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Not Statement - A logical rule statement used to negate the results of another rule statement. You provide one
Statement
within theNotStatement
. - Or
Statement Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Or Statement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement
within theOrStatement
. - Rate
Based Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Rate Based Statement A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
- IP address 10.1.1.1, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
- IP address 127.0.0.0, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide .
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .
- Regex
Match Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Regex Match Statement - A rule statement used to search web request components for a match against a single regular expression.
- Regex
Pattern Pulumi.Set Reference Statement Aws Native. Wa Fv2. Inputs. Web Acl Regex Pattern Set Reference Statement 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.Each regex pattern set rule statement references a regex pattern 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.
- Rule
Group Pulumi.Reference Statement Aws Native. Wa Fv2. Inputs. Web Acl Rule Group Reference Statement 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.You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.- Size
Constraint Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Size Constraint Statement 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.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long.- Sqli
Match Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Sqli Match Statement - 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.
- Xss
Match Pulumi.Statement Aws Native. Wa Fv2. Inputs. Web Acl Xss Match Statement - 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.
- And
Statement WebAcl And Statement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement
within theAndStatement
. - Byte
Match WebStatement Acl Byte Match Statement - 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 called a string match statement.
- Geo
Match WebStatement Acl Geo Match Statement 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.
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the AWS WAF Developer Guide .
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
- Ip
Set WebReference Statement Acl Ip Set Reference Statement 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.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.
- Label
Match WebStatement Acl Label Match Statement 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.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
- Managed
Rule WebGroup Statement Acl Managed Rule Group Statement 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 through the API call
ListAvailableManagedRuleGroups
.You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. It can only be referenced as a top-level statement within a rule.You are charged additional fees when you use the AWS WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see AWS WAF Pricing .- Not
Statement WebAcl Not Statement - A logical rule statement used to negate the results of another rule statement. You provide one
Statement
within theNotStatement
. - Or
Statement WebAcl Or Statement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement
within theOrStatement
. - Rate
Based WebStatement Acl Rate Based Statement A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
- IP address 10.1.1.1, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
- IP address 127.0.0.0, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide .
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .
- Regex
Match WebStatement Acl Regex Match Statement - A rule statement used to search web request components for a match against a single regular expression.
- Regex
Pattern WebSet Reference Statement Acl Regex Pattern Set Reference Statement 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.Each regex pattern set rule statement references a regex pattern 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.
- Rule
Group WebReference Statement Acl Rule Group Reference Statement 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.You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.- Size
Constraint WebStatement Acl Size Constraint Statement 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.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long.- Sqli
Match WebStatement Acl Sqli Match Statement - 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.
- Xss
Match WebStatement Acl Xss Match Statement - 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.
- and
Statement WebAcl And Statement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement
within theAndStatement
. - byte
Match WebStatement Acl Byte Match Statement - 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 called a string match statement.
- geo
Match WebStatement Acl Geo Match Statement 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.
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the AWS WAF Developer Guide .
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
- ip
Set WebReference Statement Acl Ip Set Reference Statement 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.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.
- label
Match WebStatement Acl Label Match Statement 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.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
- managed
Rule WebGroup Statement Acl Managed Rule Group Statement 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 through the API call
ListAvailableManagedRuleGroups
.You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. It can only be referenced as a top-level statement within a rule.You are charged additional fees when you use the AWS WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see AWS WAF Pricing .- not
Statement WebAcl Not Statement - A logical rule statement used to negate the results of another rule statement. You provide one
Statement
within theNotStatement
. - or
Statement WebAcl Or Statement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement
within theOrStatement
. - rate
Based WebStatement Acl Rate Based Statement A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
- IP address 10.1.1.1, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
- IP address 127.0.0.0, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide .
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .
- regex
Match WebStatement Acl Regex Match Statement - A rule statement used to search web request components for a match against a single regular expression.
- regex
Pattern WebSet Reference Statement Acl Regex Pattern Set Reference Statement 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.Each regex pattern set rule statement references a regex pattern 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.
- rule
Group WebReference Statement Acl Rule Group Reference Statement 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.You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.- size
Constraint WebStatement Acl Size Constraint Statement 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.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long.- sqli
Match WebStatement Acl Sqli Match Statement - 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.
- xss
Match WebStatement Acl Xss Match Statement - 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.
- and
Statement WebAcl And Statement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement
within theAndStatement
. - byte
Match WebStatement Acl Byte Match Statement - 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 called a string match statement.
- geo
Match WebStatement Acl Geo Match Statement 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.
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the AWS WAF Developer Guide .
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
- ip
Set WebReference Statement Acl Ip Set Reference Statement 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.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.
- label
Match WebStatement Acl Label Match Statement 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.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
- managed
Rule WebGroup Statement Acl Managed Rule Group Statement 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 through the API call
ListAvailableManagedRuleGroups
.You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. It can only be referenced as a top-level statement within a rule.You are charged additional fees when you use the AWS WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see AWS WAF Pricing .- not
Statement WebAcl Not Statement - A logical rule statement used to negate the results of another rule statement. You provide one
Statement
within theNotStatement
. - or
Statement WebAcl Or Statement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement
within theOrStatement
. - rate
Based WebStatement Acl Rate Based Statement A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
- IP address 10.1.1.1, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
- IP address 127.0.0.0, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide .
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .
- regex
Match WebStatement Acl Regex Match Statement - A rule statement used to search web request components for a match against a single regular expression.
- regex
Pattern WebSet Reference Statement Acl Regex Pattern Set Reference Statement 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.Each regex pattern set rule statement references a regex pattern 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.
- rule
Group WebReference Statement Acl Rule Group Reference Statement 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.You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.- size
Constraint WebStatement Acl Size Constraint Statement 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.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long.- sqli
Match WebStatement Acl Sqli Match Statement - 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.
- xss
Match WebStatement Acl Xss Match Statement - 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.
- and_
statement WebAcl And Statement - A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement
within theAndStatement
. - byte_
match_ Webstatement Acl Byte Match Statement - 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 called a string match statement.
- geo_
match_ Webstatement Acl Geo Match Statement 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.
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the AWS WAF Developer Guide .
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
- ip_
set_ Webreference_ statement Acl Ip Set Reference Statement 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.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.
- label_
match_ Webstatement Acl Label Match Statement 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.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
- managed_
rule_ Webgroup_ statement Acl Managed Rule Group Statement 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 through the API call
ListAvailableManagedRuleGroups
.You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. It can only be referenced as a top-level statement within a rule.You are charged additional fees when you use the AWS WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see AWS WAF Pricing .- not_
statement WebAcl Not Statement - A logical rule statement used to negate the results of another rule statement. You provide one
Statement
within theNotStatement
. - or_
statement WebAcl Or Statement - A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement
within theOrStatement
. - rate_
based_ Webstatement Acl Rate Based Statement A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
- IP address 10.1.1.1, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
- IP address 127.0.0.0, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide .
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .
- regex_
match_ Webstatement Acl Regex Match Statement - A rule statement used to search web request components for a match against a single regular expression.
- regex_
pattern_ Webset_ reference_ statement Acl Regex Pattern Set Reference Statement 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.Each regex pattern set rule statement references a regex pattern 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.
- rule_
group_ Webreference_ statement Acl Rule Group Reference Statement 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.You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.- size_
constraint_ Webstatement Acl Size Constraint Statement 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.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long.- sqli_
match_ Webstatement Acl Sqli Match Statement - 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.
- xss_
match_ Webstatement Acl Xss Match Statement - 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.
- and
Statement Property Map - A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement
within theAndStatement
. - byte
Match Property MapStatement - 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 called a string match statement.
- geo
Match Property MapStatement 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.
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the AWS WAF Developer Guide .
- To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
- ip
Set Property MapReference Statement 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.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.
- label
Match Property MapStatement 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.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
- managed
Rule Property MapGroup Statement 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 through the API call
ListAvailableManagedRuleGroups
.You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. It can only be referenced as a top-level statement within a rule.You are charged additional fees when you use the AWS WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see AWS WAF Pricing .- not
Statement Property Map - A logical rule statement used to negate the results of another rule statement. You provide one
Statement
within theNotStatement
. - or
Statement Property Map - A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement
within theOrStatement
. - rate
Based Property MapStatement A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
- IP address 10.1.1.1, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
- IP address 127.0.0.0, HTTP method POST
- IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1: count 3
IP address 127.0.0.0: count 1
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
HTTP method POST: count 2
HTTP method GET: count 2
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
IP address 10.1.1.1, HTTP method POST: count 1
IP address 10.1.1.1, HTTP method GET: count 2
IP address 127.0.0.0, HTTP method POST: count 1
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which AWS WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide .
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF . If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF .
- regex
Match Property MapStatement - A rule statement used to search web request components for a match against a single regular expression.
- regex
Pattern Property MapSet Reference Statement 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.Each regex pattern set rule statement references a regex pattern 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.
- rule
Group Property MapReference Statement 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.You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.- size
Constraint Property MapStatement 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.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long.- sqli
Match Property MapStatement - 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.
- xss
Match Property MapStatement - 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.
WebAclTextTransformation, WebAclTextTransformationArgs
- Priority int
- Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- Type
Pulumi.
Aws Native. Wa Fv2. Web Acl Text Transformation Type - For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide .
- Priority int
- Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- Type
Web
Acl Text Transformation Type - For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide .
- priority Integer
- Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- type
Web
Acl Text Transformation Type - For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide .
- priority number
- Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- type
Web
Acl Text Transformation Type - For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide .
- priority int
- Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- type
Web
Acl Text Transformation Type - For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide .
- priority Number
- Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- type "NONE" | "COMPRESS_WHITE_SPACE" | "HTML_ENTITY_DECODE" | "LOWERCASE" | "CMD_LINE" | "URL_DECODE" | "BASE64_DECODE" | "HEX_DECODE" | "MD5" | "REPLACE_COMMENTS" | "ESCAPE_SEQ_DECODE" | "SQL_HEX_DECODE" | "CSS_DECODE" | "JS_DECODE" | "NORMALIZE_PATH" | "NORMALIZE_PATH_WIN" | "REMOVE_NULLS" | "REPLACE_NULLS" | "BASE64_DECODE_EXT" | "URL_DECODE_UNI" | "UTF8_TO_UNICODE"
- For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide .
WebAclTextTransformationType, WebAclTextTransformationTypeArgs
- None
- NONE
- Compress
White Space - COMPRESS_WHITE_SPACE
- Html
Entity Decode - HTML_ENTITY_DECODE
- Lowercase
- LOWERCASE
- Cmd
Line - CMD_LINE
- Url
Decode - URL_DECODE
- Base64Decode
- BASE64_DECODE
- Hex
Decode - HEX_DECODE
- Md5
- MD5
- Replace
Comments - REPLACE_COMMENTS
- Escape
Seq Decode - ESCAPE_SEQ_DECODE
- Sql
Hex Decode - SQL_HEX_DECODE
- Css
Decode - CSS_DECODE
- Js
Decode - JS_DECODE
- Normalize
Path - NORMALIZE_PATH
- Normalize
Path Win - NORMALIZE_PATH_WIN
- Remove
Nulls - REMOVE_NULLS
- Replace
Nulls - REPLACE_NULLS
- Base64Decode
Ext - BASE64_DECODE_EXT
- Url
Decode Uni - URL_DECODE_UNI
- Utf8To
Unicode - UTF8_TO_UNICODE
- Web
Acl Text Transformation Type None - NONE
- Web
Acl Text Transformation Type Compress White Space - COMPRESS_WHITE_SPACE
- Web
Acl Text Transformation Type Html Entity Decode - HTML_ENTITY_DECODE
- Web
Acl Text Transformation Type Lowercase - LOWERCASE
- Web
Acl Text Transformation Type Cmd Line - CMD_LINE
- Web
Acl Text Transformation Type Url Decode - URL_DECODE
- Web
Acl Text Transformation Type Base64Decode - BASE64_DECODE
- Web
Acl Text Transformation Type Hex Decode - HEX_DECODE
- Web
Acl Text Transformation Type Md5 - MD5
- Web
Acl Text Transformation Type Replace Comments - REPLACE_COMMENTS
- Web
Acl Text Transformation Type Escape Seq Decode - ESCAPE_SEQ_DECODE
- Web
Acl Text Transformation Type Sql Hex Decode - SQL_HEX_DECODE
- Web
Acl Text Transformation Type Css Decode - CSS_DECODE
- Web
Acl Text Transformation Type Js Decode - JS_DECODE
- Web
Acl Text Transformation Type Normalize Path - NORMALIZE_PATH
- Web
Acl Text Transformation Type Normalize Path Win - NORMALIZE_PATH_WIN
- Web
Acl Text Transformation Type Remove Nulls - REMOVE_NULLS
- Web
Acl Text Transformation Type Replace Nulls - REPLACE_NULLS
- Web
Acl Text Transformation Type Base64Decode Ext - BASE64_DECODE_EXT
- Web
Acl Text Transformation Type Url Decode Uni - URL_DECODE_UNI
- Web
Acl Text Transformation Type Utf8To Unicode - UTF8_TO_UNICODE
- None
- NONE
- Compress
White Space - COMPRESS_WHITE_SPACE
- Html
Entity Decode - HTML_ENTITY_DECODE
- Lowercase
- LOWERCASE
- Cmd
Line - CMD_LINE
- Url
Decode - URL_DECODE
- Base64Decode
- BASE64_DECODE
- Hex
Decode - HEX_DECODE
- Md5
- MD5
- Replace
Comments - REPLACE_COMMENTS
- Escape
Seq Decode - ESCAPE_SEQ_DECODE
- Sql
Hex Decode - SQL_HEX_DECODE
- Css
Decode - CSS_DECODE
- Js
Decode - JS_DECODE
- Normalize
Path - NORMALIZE_PATH
- Normalize
Path Win - NORMALIZE_PATH_WIN
- Remove
Nulls - REMOVE_NULLS
- Replace
Nulls - REPLACE_NULLS
- Base64Decode
Ext - BASE64_DECODE_EXT
- Url
Decode Uni - URL_DECODE_UNI
- Utf8To
Unicode - UTF8_TO_UNICODE
- None
- NONE
- Compress
White Space - COMPRESS_WHITE_SPACE
- Html
Entity Decode - HTML_ENTITY_DECODE
- Lowercase
- LOWERCASE
- Cmd
Line - CMD_LINE
- Url
Decode - URL_DECODE
- Base64Decode
- BASE64_DECODE
- Hex
Decode - HEX_DECODE
- Md5
- MD5
- Replace
Comments - REPLACE_COMMENTS
- Escape
Seq Decode - ESCAPE_SEQ_DECODE
- Sql
Hex Decode - SQL_HEX_DECODE
- Css
Decode - CSS_DECODE
- Js
Decode - JS_DECODE
- Normalize
Path - NORMALIZE_PATH
- Normalize
Path Win - NORMALIZE_PATH_WIN
- Remove
Nulls - REMOVE_NULLS
- Replace
Nulls - REPLACE_NULLS
- Base64Decode
Ext - BASE64_DECODE_EXT
- Url
Decode Uni - URL_DECODE_UNI
- Utf8To
Unicode - UTF8_TO_UNICODE
- NONE
- NONE
- COMPRESS_WHITE_SPACE
- COMPRESS_WHITE_SPACE
- HTML_ENTITY_DECODE
- HTML_ENTITY_DECODE
- LOWERCASE
- LOWERCASE
- CMD_LINE
- CMD_LINE
- URL_DECODE
- URL_DECODE
- BASE64_DECODE
- BASE64_DECODE
- HEX_DECODE
- HEX_DECODE
- MD5
- MD5
- REPLACE_COMMENTS
- REPLACE_COMMENTS
- ESCAPE_SEQ_DECODE
- ESCAPE_SEQ_DECODE
- SQL_HEX_DECODE
- SQL_HEX_DECODE
- CSS_DECODE
- CSS_DECODE
- JS_DECODE
- JS_DECODE
- NORMALIZE_PATH
- NORMALIZE_PATH
- NORMALIZE_PATH_WIN
- NORMALIZE_PATH_WIN
- REMOVE_NULLS
- REMOVE_NULLS
- REPLACE_NULLS
- REPLACE_NULLS
- BASE64_DECODE_EXT
- BASE64_DECODE_EXT
- URL_DECODE_UNI
- URL_DECODE_UNI
- UTF8_TO_UNICODE
- UTF8_TO_UNICODE
- "NONE"
- NONE
- "COMPRESS_WHITE_SPACE"
- COMPRESS_WHITE_SPACE
- "HTML_ENTITY_DECODE"
- HTML_ENTITY_DECODE
- "LOWERCASE"
- LOWERCASE
- "CMD_LINE"
- CMD_LINE
- "URL_DECODE"
- URL_DECODE
- "BASE64_DECODE"
- BASE64_DECODE
- "HEX_DECODE"
- HEX_DECODE
- "MD5"
- MD5
- "REPLACE_COMMENTS"
- REPLACE_COMMENTS
- "ESCAPE_SEQ_DECODE"
- ESCAPE_SEQ_DECODE
- "SQL_HEX_DECODE"
- SQL_HEX_DECODE
- "CSS_DECODE"
- CSS_DECODE
- "JS_DECODE"
- JS_DECODE
- "NORMALIZE_PATH"
- NORMALIZE_PATH
- "NORMALIZE_PATH_WIN"
- NORMALIZE_PATH_WIN
- "REMOVE_NULLS"
- REMOVE_NULLS
- "REPLACE_NULLS"
- REPLACE_NULLS
- "BASE64_DECODE_EXT"
- BASE64_DECODE_EXT
- "URL_DECODE_UNI"
- URL_DECODE_UNI
- "UTF8_TO_UNICODE"
- UTF8_TO_UNICODE
WebAclVisibilityConfig, WebAclVisibilityConfigArgs
- Cloud
Watch boolMetrics Enabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .
- Metric
Name string - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example
All
andDefault_Action
. - Sampled
Requests boolEnabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
- Cloud
Watch boolMetrics Enabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .
- Metric
Name string - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example
All
andDefault_Action
. - Sampled
Requests boolEnabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
- cloud
Watch BooleanMetrics Enabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .
- metric
Name String - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example
All
andDefault_Action
. - sampled
Requests BooleanEnabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
- cloud
Watch booleanMetrics Enabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .
- metric
Name string - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example
All
andDefault_Action
. - sampled
Requests booleanEnabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
- cloud_
watch_ boolmetrics_ enabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .
- metric_
name str - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example
All
andDefault_Action
. - sampled_
requests_ boolenabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
- cloud
Watch BooleanMetrics Enabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .
- metric
Name String - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example
All
andDefault_Action
. - sampled
Requests BooleanEnabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
WebAclXssMatchStatement, WebAclXssMatchStatementArgs
- Field
To Pulumi.Match Aws Native. Wa Fv2. Inputs. Web Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Text
Transformations List<Pulumi.Aws Native. Wa Fv2. Inputs. Web Acl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- Field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- Text
Transformations []WebAcl Text Transformation - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text
Transformations List<WebAcl Text Transformation> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field
To WebMatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text
Transformations WebAcl Text Transformation[] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field_
to_ Webmatch Acl Field To Match - The part of the web request that you want AWS WAF to inspect.
- text_
transformations Sequence[WebAcl Text Transformation] - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
- field
To Property MapMatch - The part of the web request that you want AWS WAF to inspect.
- text
Transformations List<Property Map> - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by
FieldToMatch
, starting from the lowest priority setting, before inspecting the content for a match.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.