wafv2/aws.sdk.kotlin.services.wafv2.model/RuleGroup/Builder

Builder

Properties

The Amazon Resource Name (ARN) of the entity.

var availableLabels: List<LabelSummary>?

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.

capacity

var capacity: Long?

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

consumedLabels

var consumedLabels: List<LabelSummary>?

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.

customResponseBodies

var customResponseBodies: Map<String, CustomResponseBody>?

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.

description

var description: String?

A description of the rule group that helps with identification.

var id: String?

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

labelNamespace

var labelNamespace: String?

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

monetizationConfig

var monetizationConfig: MonetizationConfig?

The monetization configuration for the rule group. Required when any rule in the rule group uses the Monetize action. When a rule group with a MonetizationConfig is used in a web ACL, the rule group's configuration applies to rules within that group unless overridden at the web ACL level.

name

var name: String?

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

rules

var rules: List<Rule>?

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

visibilityConfig

var visibilityConfig: VisibilityConfig?

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

Functions

monetizationConfig

fun monetizationConfig(block: MonetizationConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.wafv2.model.MonetizationConfig inside the given block

visibilityConfig

fun visibilityConfig(block: VisibilityConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.wafv2.model.VisibilityConfig inside the given block