Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-08-20T12:34:53.238Z")
@Stability(Stable)
public interface CfnRuleGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRuleGroup.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleGroupProps.Builder	A builder for CfnRuleGroupProps
static final class	CfnRuleGroupProps.Jsii$Proxy	An implementation for CfnRuleGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroupProps.Builder	builder()
default Object	getAvailableLabels()	The labels that one or more rules in this rule group add to matching web requests.
Number	getCapacity()	The web ACL capacity units (WCUs) required for this rule group.
default Object	getConsumedLabels()	The labels that one or more rules in this rule group match against in label match statements.
default Object	getCustomResponseBodies()	A map of custom response keys and content bodies.
default String	getDescription()	A description of the rule group that helps with identification.
default String	getName()	The name of the rule group.
default Object	getRules()	The rule statements used to identify the web requests that you want to allow, block, or count.
String	getScope()	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
default List<CfnTag>	getTags()	Key:value pairs associated with an AWS resource.
Object	getVisibilityConfig()	Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacity

@Stability(Stable)
@NotNull
Number getCapacity()

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-capacity

getScope

@Stability(Stable)
@NotNull
String getScope()

Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

For an AWS Amplify application, use CLOUDFRONT . 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 and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-scope

getVisibilityConfig

@Stability(Stable)
@NotNull
Object getVisibilityConfig()

Defines and enables Amazon CloudWatch metrics and web request sample collection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-visibilityconfig

getAvailableLabels

@Stability(Stable)
@Nullable
default Object getAvailableLabels()

The labels that one or more rules in this rule group add to matching web requests.

These labels are defined in the RuleLabels for a Rule .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-availablelabels

getConsumedLabels

@Stability(Stable)
@Nullable
default Object getConsumedLabels()

The labels that one or more rules in this rule group match against in label match statements.

These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-consumedlabels

getCustomResponseBodies

@Stability(Stable)
@Nullable
default Object getCustomResponseBodies()

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 rule group, and then use them in the rules that you define in the rule group.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-customresponsebodies

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the rule group that helps with identification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the rule group.

You cannot change the name of a rule group after you create it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-name

getRules

@Stability(Stable)
@Nullable
default Object getRules()

The rule statements used to identify the web requests that you want to allow, block, or count.

Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-rules

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-tags

builder

@Stability(Stable)
static CfnRuleGroupProps.Builder builder()

Returns:

a CfnRuleGroupProps.Builder of CfnRuleGroupProps