RuleGroupArgs

data class RuleGroupArgs(val availableLabels: Output<List<RuleGroupLabelSummaryArgs>>? = null, val capacity: Output<Int>? = null, val consumedLabels: Output<List<RuleGroupLabelSummaryArgs>>? = null, val customResponseBodies: Output<Map<String, RuleGroupCustomResponseBodyArgs>>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val rules: Output<List<RuleGroupRuleArgs>>? = null, val scope: Output<RuleGroupScope>? = null, val tags: Output<List<TagArgs>>? = null, val visibilityConfig: Output<RuleGroupVisibilityConfigArgs>? = null) : ConvertibleToJava<RuleGroupArgs>

Contains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.

Constructors

Link copied to clipboard
constructor(availableLabels: Output<List<RuleGroupLabelSummaryArgs>>? = null, capacity: Output<Int>? = null, consumedLabels: Output<List<RuleGroupLabelSummaryArgs>>? = null, customResponseBodies: Output<Map<String, RuleGroupCustomResponseBodyArgs>>? = null, description: Output<String>? = null, name: Output<String>? = null, rules: Output<List<RuleGroupRuleArgs>>? = null, scope: Output<RuleGroupScope>? = null, tags: Output<List<TagArgs>>? = null, visibilityConfig: Output<RuleGroupVisibilityConfigArgs>? = null)

Properties

Link copied to clipboard

Collection of Available Labels.

Link copied to clipboard
val capacity: Output<Int>? = null

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.

Link copied to clipboard

Collection of Consumed Labels.

Link copied to clipboard

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 .

Link copied to clipboard
val description: Output<String>? = null

A description of the rule group that helps with identification.

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val rules: Output<List<RuleGroupRuleArgs>>? = null

Collection of Rules.

Link copied to clipboard
val scope: Output<RuleGroupScope>? = null

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 and REGIONAL .

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

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.

Link copied to clipboard

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

Functions

Link copied to clipboard
open override fun toJava(): RuleGroupArgs