Interface ICfnRuleGroupProps
Properties for defining a CfnRuleGroup.
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnRuleGroupPropsSyntax (vb)
Public Interface ICfnRuleGroupPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html
ExampleMetadata: fixture=_generated
Synopsis
Properties
| AvailableLabels | The labels that one or more rules in this rule group add to matching web requests. |
| Capacity | The web ACL capacity units (WCUs) required for this rule group. |
| ConsumedLabels | The labels that one or more rules in this rule group match against in label match statements. |
| CustomResponseBodies | A map of custom response keys and content bodies. |
| Description | A description of the rule group that helps with identification. |
| Name | The name of the rule group. |
| Rules | The rule statements used to identify the web requests that you want to allow, block, or count. |
| Scope | Specifies whether this is for an Amazon CloudFront distribution or for a regional application. |
| Tags | Key:value pairs associated with an AWS resource. |
| VisibilityConfig | Defines and enables Amazon CloudWatch metrics and web request sample collection. |
Properties
AvailableLabels
The labels that one or more rules in this rule group add to matching web requests.
object? AvailableLabels { get; }Property Value
Remarks
These labels are defined in the RuleLabels for a Rule .
Type union: either IResolvable or (either IResolvable or CfnRuleGroup.ILabelSummaryProperty)[]
Capacity
The web ACL capacity units (WCUs) required for this rule group.
double Capacity { get; }Property Value
Remarks
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.
ConsumedLabels
The labels that one or more rules in this rule group match against in label match statements.
object? ConsumedLabels { get; }Property Value
Remarks
These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Type union: either IResolvable or (either IResolvable or CfnRuleGroup.ILabelSummaryProperty)[]
CustomResponseBodies
A map of custom response keys and content bodies.
object? CustomResponseBodies { get; }Property Value
Remarks
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 .
Type union: either IResolvable or Dictionary<string, either IResolvable or CfnRuleGroup.ICustomResponseBodyProperty>
Description
A description of the rule group that helps with identification.
string? Description { get; }Property Value
Remarks
Name
The name of the rule group.
string? Name { get; }Property Value
Remarks
You cannot change the name of a rule group after you create it.
Rules
The rule statements used to identify the web requests that you want to allow, block, or count.
object? Rules { get; }Property Value
Remarks
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.
Type union: either IResolvable or (either IResolvable or CfnRuleGroup.IRuleProperty)[]
Scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
string Scope { get; }Property Value
Remarks
For an AWS Amplify application, use CLOUDFRONT . A regional application can be an Application Load Balancer (ALB), an 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 <code>CLOUDFRONT</code> , you must create your WAFv2 resources in the US East (N. Virginia) Region, <code>us-east-1</code> .
Tags
Key:value pairs associated with an AWS resource.
ICfnTag[]? Tags { get; }Property Value
ICfnTag[]
Remarks
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.
VisibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
object VisibilityConfig { get; }