Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wafv2.CfnRuleGroup
All Implemented Interfaces:
IInspectable, ITaggable, IRuleGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:50.366Z") @Stability(Stable) public class CfnRuleGroup extends CfnResource implements IInspectable, IRuleGroupRef, ITaggable

This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

Use an RuleGroup to define a collection of rules for inspecting and controlling web requests. You use a rule group in an WebACL by providing its Amazon Resource Name (ARN) to the rule statement RuleGroupReferenceStatement , when you add rules to the web ACL.

When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Example:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRuleGroup

      protected CfnRuleGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRuleGroup

      protected CfnRuleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRuleGroup

      @Stability(Stable) public CfnRuleGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRuleGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the rule group.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the rule group.

    • getAttrLabelNamespace

      @Stability(Stable) @NotNull public String getAttrLabelNamespace()
      The label namespace prefix for this rule group.

      All labels added by rules in this rule group have this prefix.

      The syntax for the label namespace prefix for a rule group is the following: awswaf:<account ID>:rule group:<rule group 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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRuleGroupRef

      @Stability(Stable) @NotNull public RuleGroupReference getRuleGroupRef()
      A reference to a RuleGroup resource.
      Specified by:
      getRuleGroupRef in interface IRuleGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCapacity

      @Stability(Stable) @NotNull public Number getCapacity()
      The web ACL capacity units (WCUs) required for this rule group.

    • setCapacity

      @Stability(Stable) public void setCapacity(@NotNull Number value)
      The web ACL capacity units (WCUs) required for this rule group.

    • getScope

      @Stability(Stable) @NotNull public String getScope()
      Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

    • setScope

      @Stability(Stable) public void setScope(@NotNull String value)
      Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

    • getVisibilityConfig

      @Stability(Stable) @NotNull public Object getVisibilityConfig()
      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      Returns union: either IResolvable or CfnRuleGroup.VisibilityConfigProperty

    • setVisibilityConfig

      @Stability(Stable) public void setVisibilityConfig(@NotNull IResolvable value)
      Defines and enables Amazon CloudWatch metrics and web request sample collection.

    • setVisibilityConfig

      @Stability(Stable) public void setVisibilityConfig(@NotNull CfnRuleGroup.VisibilityConfigProperty value)
      Defines and enables Amazon CloudWatch metrics and web request sample collection.

    • getAvailableLabels

      @Stability(Stable) @Nullable public Object getAvailableLabels()
      The labels that one or more rules in this rule group add to matching web requests.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRuleGroup.LabelSummaryProperty>

    • setAvailableLabels

      @Stability(Stable) public void setAvailableLabels(@Nullable IResolvable value)
      The labels that one or more rules in this rule group add to matching web requests.

    • setAvailableLabels

      @Stability(Stable) public void setAvailableLabels(@Nullable List<Object> value)
      The labels that one or more rules in this rule group add to matching web requests.

    • getConsumedLabels

      @Stability(Stable) @Nullable public Object getConsumedLabels()
      The labels that one or more rules in this rule group match against in label match statements.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRuleGroup.LabelSummaryProperty>

    • setConsumedLabels

      @Stability(Stable) public void setConsumedLabels(@Nullable IResolvable value)
      The labels that one or more rules in this rule group match against in label match statements.

    • setConsumedLabels

      @Stability(Stable) public void setConsumedLabels(@Nullable List<Object> value)
      The labels that one or more rules in this rule group match against in label match statements.

    • getCustomResponseBodies

      @Stability(Stable) @Nullable public Object getCustomResponseBodies()
      A map of custom response keys and content bodies.

      Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnRuleGroup.CustomResponseBodyProperty>

    • setCustomResponseBodies

      @Stability(Stable) public void setCustomResponseBodies(@Nullable IResolvable value)
      A map of custom response keys and content bodies.

    • setCustomResponseBodies

      @Stability(Stable) public void setCustomResponseBodies(@Nullable Map<String,Object> value)
      A map of custom response keys and content bodies.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the rule group that helps with identification.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the rule group that helps with identification.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the rule group.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the rule group.

    • getRules

      @Stability(Stable) @Nullable public Object getRules()
      The rule statements used to identify the web requests that you want to allow, block, or count.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRuleGroup.RuleProperty>

    • setRules

      @Stability(Stable) public void setRules(@Nullable IResolvable value)
      The rule statements used to identify the web requests that you want to allow, block, or count.

    • setRules

      @Stability(Stable) public void setRules(@Nullable List<Object> value)
      The rule statements used to identify the web requests that you want to allow, block, or count.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key:value pairs associated with an AWS resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key:value pairs associated with an AWS resource.