Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.wafv2.CfnRuleGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:36.183Z")
@Stability(Stable)
public class CfnRuleGroup
extends CfnResource
implements IInspectable

A CloudFormation AWS::WAFv2::RuleGroup.

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:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 Object all;
 Object allow;
 Object allQueryArguments;
 Object block;
 Object captcha;
 Object challenge;
 Object count;
 Object method;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 StatementProperty statementProperty_;
 Object uriPath;
 CfnRuleGroup cfnRuleGroup = CfnRuleGroup.Builder.create(this, "MyCfnRuleGroup")
         .capacity(123)
         .scope("scope")
         .visibilityConfig(VisibilityConfigProperty.builder()
                 .cloudWatchMetricsEnabled(false)
                 .metricName("metricName")
                 .sampledRequestsEnabled(false)
                 .build())
         // the properties below are optional
         .availableLabels(List.of(LabelSummaryProperty.builder()
                 .name("name")
                 .build()))
         .consumedLabels(List.of(LabelSummaryProperty.builder()
                 .name("name")
                 .build()))
         .customResponseBodies(Map.of(
                 "customResponseBodiesKey", CustomResponseBodyProperty.builder()
                         .content("content")
                         .contentType("contentType")
                         .build()))
         .description("description")
         .name("name")
         .rules(List.of(RuleProperty.builder()
                 .name("name")
                 .priority(123)
                 .statement(StatementProperty.builder()
                         .andStatement(AndStatementProperty.builder()
                                 .statements(List.of(statementProperty_))
                                 .build())
                         .byteMatchStatement(ByteMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(BodyProperty.builder()
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .cookies(CookiesProperty.builder()
                                                 .matchPattern(CookieMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedCookies(List.of("excludedCookies"))
                                                         .includedCookies(List.of("includedCookies"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .headers(HeadersProperty.builder()
                                                 .matchPattern(HeaderMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedHeaders(List.of("excludedHeaders"))
                                                         .includedHeaders(List.of("includedHeaders"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .positionalConstraint("positionalConstraint")
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 // the properties below are optional
                                 .searchString("searchString")
                                 .searchStringBase64("searchStringBase64")
                                 .build())
                         .geoMatchStatement(GeoMatchStatementProperty.builder()
                                 .countryCodes(List.of("countryCodes"))
                                 .forwardedIpConfig(ForwardedIPConfigurationProperty.builder()
                                         .fallbackBehavior("fallbackBehavior")
                                         .headerName("headerName")
                                         .build())
                                 .build())
                         .ipSetReferenceStatement(Map.of(
                                 "arn", "arn",
                                 // the properties below are optional
                                 "ipSetForwardedIpConfig", Map.of(
                                         "fallbackBehavior", "fallbackBehavior",
                                         "headerName", "headerName",
                                         "position", "position")))
                         .labelMatchStatement(LabelMatchStatementProperty.builder()
                                 .key("key")
                                 .scope("scope")
                                 .build())
                         .notStatement(NotStatementProperty.builder()
                                 .statement(statementProperty_)
                                 .build())
                         .orStatement(OrStatementProperty.builder()
                                 .statements(List.of(statementProperty_))
                                 .build())
                         .rateBasedStatement(RateBasedStatementProperty.builder()
                                 .aggregateKeyType("aggregateKeyType")
                                 .limit(123)
                                 // the properties below are optional
                                 .forwardedIpConfig(ForwardedIPConfigurationProperty.builder()
                                         .fallbackBehavior("fallbackBehavior")
                                         .headerName("headerName")
                                         .build())
                                 .scopeDownStatement(statementProperty_)
                                 .build())
                         .regexMatchStatement(RegexMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(BodyProperty.builder()
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .cookies(CookiesProperty.builder()
                                                 .matchPattern(CookieMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedCookies(List.of("excludedCookies"))
                                                         .includedCookies(List.of("includedCookies"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .headers(HeadersProperty.builder()
                                                 .matchPattern(HeaderMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedHeaders(List.of("excludedHeaders"))
                                                         .includedHeaders(List.of("includedHeaders"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .regexString("regexString")
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .regexPatternSetReferenceStatement(RegexPatternSetReferenceStatementProperty.builder()
                                 .arn("arn")
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(BodyProperty.builder()
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .cookies(CookiesProperty.builder()
                                                 .matchPattern(CookieMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedCookies(List.of("excludedCookies"))
                                                         .includedCookies(List.of("includedCookies"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .headers(HeadersProperty.builder()
                                                 .matchPattern(HeaderMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedHeaders(List.of("excludedHeaders"))
                                                         .includedHeaders(List.of("includedHeaders"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .sizeConstraintStatement(SizeConstraintStatementProperty.builder()
                                 .comparisonOperator("comparisonOperator")
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(BodyProperty.builder()
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .cookies(CookiesProperty.builder()
                                                 .matchPattern(CookieMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedCookies(List.of("excludedCookies"))
                                                         .includedCookies(List.of("includedCookies"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .headers(HeadersProperty.builder()
                                                 .matchPattern(HeaderMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedHeaders(List.of("excludedHeaders"))
                                                         .includedHeaders(List.of("includedHeaders"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .size(123)
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .sqliMatchStatement(SqliMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(BodyProperty.builder()
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .cookies(CookiesProperty.builder()
                                                 .matchPattern(CookieMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedCookies(List.of("excludedCookies"))
                                                         .includedCookies(List.of("includedCookies"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .headers(HeadersProperty.builder()
                                                 .matchPattern(HeaderMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedHeaders(List.of("excludedHeaders"))
                                                         .includedHeaders(List.of("includedHeaders"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 // the properties below are optional
                                 .sensitivityLevel("sensitivityLevel")
                                 .build())
                         .xssMatchStatement(XssMatchStatementProperty.builder()
                                 .fieldToMatch(FieldToMatchProperty.builder()
                                         .allQueryArguments(allQueryArguments)
                                         .body(BodyProperty.builder()
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .cookies(CookiesProperty.builder()
                                                 .matchPattern(CookieMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedCookies(List.of("excludedCookies"))
                                                         .includedCookies(List.of("includedCookies"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .headers(HeadersProperty.builder()
                                                 .matchPattern(HeaderMatchPatternProperty.builder()
                                                         .all(all)
                                                         .excludedHeaders(List.of("excludedHeaders"))
                                                         .includedHeaders(List.of("includedHeaders"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .jsonBody(JsonBodyProperty.builder()
                                                 .matchPattern(JsonMatchPatternProperty.builder()
                                                         .all(all)
                                                         .includedPaths(List.of("includedPaths"))
                                                         .build())
                                                 .matchScope("matchScope")
                                                 // the properties below are optional
                                                 .invalidFallbackBehavior("invalidFallbackBehavior")
                                                 .oversizeHandling("oversizeHandling")
                                                 .build())
                                         .method(method)
                                         .queryString(queryString)
                                         .singleHeader(singleHeader)
                                         .singleQueryArgument(singleQueryArgument)
                                         .uriPath(uriPath)
                                         .build())
                                 .textTransformations(List.of(TextTransformationProperty.builder()
                                         .priority(123)
                                         .type("type")
                                         .build()))
                                 .build())
                         .build())
                 .visibilityConfig(VisibilityConfigProperty.builder()
                         .cloudWatchMetricsEnabled(false)
                         .metricName("metricName")
                         .sampledRequestsEnabled(false)
                         .build())
                 // the properties below are optional
                 .action(RuleActionProperty.builder()
                         .allow(allow)
                         .block(block)
                         .captcha(captcha)
                         .challenge(challenge)
                         .count(count)
                         .build())
                 .captchaConfig(CaptchaConfigProperty.builder()
                         .immunityTimeProperty(ImmunityTimePropertyProperty.builder()
                                 .immunityTime(123)
                                 .build())
                         .build())
                 .challengeConfig(ChallengeConfigProperty.builder()
                         .immunityTimeProperty(ImmunityTimePropertyProperty.builder()
                                 .immunityTime(123)
                                 .build())
                         .build())
                 .ruleLabels(List.of(LabelProperty.builder()
                         .name("name")
                         .build()))
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnRuleGroup.AllowProperty	Example:
static interface	CfnRuleGroup.AndStatementProperty	A logical rule statement used to combine other rule statements with AND logic.
static interface	CfnRuleGroup.BlockProperty	Example:
static interface	CfnRuleGroup.BodyProperty	Inspect the body of the web request.
static final class	CfnRuleGroup.Builder	A fluent builder for CfnRuleGroup.
static interface	CfnRuleGroup.ByteMatchStatementProperty	A rule statement that defines a string match search for AWS WAF to apply to web requests.
static interface	CfnRuleGroup.CaptchaConfigProperty	Specifies how AWS WAF should handle CAPTCHA evaluations.
static interface	CfnRuleGroup.CaptchaProperty	Example:
static interface	CfnRuleGroup.ChallengeConfigProperty	Specifies how AWS WAF should handle Challenge evaluations.
static interface	CfnRuleGroup.ChallengeProperty	Example:
static interface	CfnRuleGroup.CookieMatchPatternProperty	The filter to use to identify the subset of cookies to inspect in a web request.
static interface	CfnRuleGroup.CookiesProperty	Inspect the cookies in the web request.
static interface	CfnRuleGroup.CountProperty	Example:
static interface	CfnRuleGroup.CustomHTTPHeaderProperty	A custom header for custom request and response handling.
static interface	CfnRuleGroup.CustomRequestHandlingProperty	Custom request handling behavior that inserts custom headers into a web request.
static interface	CfnRuleGroup.CustomResponseBodyProperty	The response body to use in a custom response to a web request.
static interface	CfnRuleGroup.CustomResponseProperty	A custom response to send to the client.
static interface	CfnRuleGroup.FieldToMatchProperty	The part of the web request that you want AWS WAF to inspect.
static interface	CfnRuleGroup.ForwardedIPConfigurationProperty	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.
static interface	CfnRuleGroup.GeoMatchStatementProperty	A rule statement that labels web requests by country and region and that matches against web requests based on country code.
static interface	CfnRuleGroup.HeaderMatchPatternProperty	The filter to use to identify the subset of headers to inspect in a web request.
static interface	CfnRuleGroup.HeadersProperty	Inspect all headers in the web request.
static interface	CfnRuleGroup.ImmunityTimePropertyProperty	Used for CAPTCHA and challenge token settings.
static interface	CfnRuleGroup.IPSetForwardedIPConfigurationProperty	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.
static interface	CfnRuleGroup.IPSetReferenceStatementProperty	A rule statement used to detect web requests coming from particular IP addresses or address ranges.
static interface	CfnRuleGroup.JsonBodyProperty	Inspect the body of the web request as JSON.
static interface	CfnRuleGroup.JsonMatchPatternProperty	The patterns to look for in the JSON body.
static interface	CfnRuleGroup.LabelMatchStatementProperty	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.
static interface	CfnRuleGroup.LabelProperty	A single label container.
static interface	CfnRuleGroup.LabelSummaryProperty	List of labels used by one or more of the rules of a RuleGroup .
static interface	CfnRuleGroup.NotStatementProperty	A logical rule statement used to negate the results of another rule statement.
static interface	CfnRuleGroup.OrStatementProperty	A logical rule statement used to combine other rule statements with OR logic.
static interface	CfnRuleGroup.RateBasedStatementProperty	A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span.
static interface	CfnRuleGroup.RegexMatchStatementProperty	A rule statement used to search web request components for a match against a single regular expression.
static interface	CfnRuleGroup.RegexPatternSetReferenceStatementProperty	A rule statement used to search web request components for matches with regular expressions.
static interface	CfnRuleGroup.RuleActionProperty	The action that AWS WAF should take on a web request when it matches a rule's statement.
static interface	CfnRuleGroup.RuleProperty	A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count.
static interface	CfnRuleGroup.SingleHeaderProperty	Inspect one of the headers in the web request, identified by name, for example, User-Agent or Referer .
static interface	CfnRuleGroup.SingleQueryArgumentProperty	Inspect one query argument in the web request, identified by name, for example UserName or SalesRegion .
static interface	CfnRuleGroup.SizeConstraintStatementProperty	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 (<).
static interface	CfnRuleGroup.SqliMatchStatementProperty	A rule statement that inspects for malicious SQL code.
static interface	CfnRuleGroup.StatementProperty	The processing guidance for a rule, used by AWS WAF to determine whether a web request matches the rule.
static interface	CfnRuleGroup.TextTransformationProperty	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
static interface	CfnRuleGroup.VisibilityConfigProperty	Defines and enables Amazon CloudWatch metrics and web request sample collection.
static interface	CfnRuleGroup.XssMatchStatementProperty	A rule statement that inspects for cross-site scripting (XSS) attacks.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnRuleGroup(Construct scope, String id, CfnRuleGroupProps props)	Create a new AWS::WAFv2::RuleGroup.
protected	CfnRuleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRuleGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the rule group.
String	getAttrId()	The ID of the rule group.
String	getAttrLabelNamespace()	The label namespace prefix for this rule group.
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.
protected Map<String,Object>	getCfnProperties()
Object	getConsumedLabels()	The labels that one or more rules in this rule group match against in label match statements.
Object	getCustomResponseBodies()	A map of custom response keys and content bodies.
String	getDescription()	A description of the rule group that helps with identification.
String	getName()	The name of the rule group.
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.
TagManager	getTags()	Key:value pairs associated with an AWS resource.
Object	getVisibilityConfig()	Defines and enables Amazon CloudWatch metrics and web request sample collection.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailableLabels(List<Object> value)	The labels that one or more rules in this rule group add to matching web requests.
void	setAvailableLabels(IResolvable value)	The labels that one or more rules in this rule group add to matching web requests.
void	setCapacity(Number value)	The web ACL capacity units (WCUs) required for this rule group.
void	setConsumedLabels(List<Object> value)	The labels that one or more rules in this rule group match against in label match statements.
void	setConsumedLabels(IResolvable value)	The labels that one or more rules in this rule group match against in label match statements.
void	setCustomResponseBodies(Map<String,Object> value)	A map of custom response keys and content bodies.
void	setCustomResponseBodies(IResolvable value)	A map of custom response keys and content bodies.
void	setDescription(String value)	A description of the rule group that helps with identification.
void	setName(String value)	The name of the rule group.
void	setRules(List<Object> value)	The rule statements used to identify the web requests that you want to allow, block, or count.
void	setRules(IResolvable value)	The rule statements used to identify the web requests that you want to allow, block, or count.
void	setScope(String value)	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
void	setVisibilityConfig(IResolvable value)	Defines and enables Amazon CloudWatch metrics and web request sample collection.
void	setVisibilityConfig(CfnRuleGroup.VisibilityConfigProperty value)	Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnRuleGroupProps props)

Create a new AWS::WAFv2::RuleGroup.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

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

getTags

@Stability(Stable)
@NotNull
public TagManager 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.

getCapacity

@Stability(Stable)
@NotNull
public 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.

setCapacity

@Stability(Stable)
public void setCapacity(@NotNull
 Number value)

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.

getScope

@Stability(Stable)
@NotNull
public String getScope()

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, or an AWS App Runner service. Valid Values are CLOUDFRONT and REGIONAL .

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

setScope

@Stability(Stable)
public void setScope(@NotNull
 String value)

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, or an AWS App Runner service. Valid Values are CLOUDFRONT and REGIONAL .

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

getVisibilityConfig

@Stability(Stable)
@NotNull
public Object getVisibilityConfig()

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

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.

These labels are defined in the RuleLabels for a Rule .

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.

These labels are defined in the RuleLabels for a Rule .

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.

These labels are defined in the RuleLabels for a Rule .

getConsumedLabels

@Stability(Stable)
@Nullable
public 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.

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.

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

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.

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

getCustomResponseBodies

@Stability(Stable)
@Nullable
public 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 .

setCustomResponseBodies

@Stability(Stable)
public void setCustomResponseBodies(@Nullable
 IResolvable value)

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 .

setCustomResponseBodies

@Stability(Stable)
public void setCustomResponseBodies(@Nullable
 Map<String,Object> value)

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 .

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.

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

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the rule group.

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

getRules

@Stability(Stable)
@Nullable
public 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.

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.

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.

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.

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.