RuleGroupArgs class

The set of arguments for RuleGroup. The set of arguments for RuleGroup.

Constructors

RuleGroupArgs({required Input<int> capacity, Input<List<RuleGroupCustomResponseBody>?>? customResponseBodies, Input<String?>? description, Input<String?>? name, Input<String?>? namePrefix, Input<String?>? region, Input<List<RuleGroupRule>?>? rules, Input<String?>? rulesJson, required Input<String> scope, Input<Map<String, String>?>? tags, required Input<RuleGroupVisibilityConfig> visibilityConfig})
Creates a new RuleGroupArgs. capacity The web ACL capacity units (WCUs) required for this rule group. See here for general information and here for capacity specific information. customResponseBodies Defines custom response bodies that can be referenced by customResponse actions. See Custom Response Body below for details. description A friendly description of the rule group. name A friendly name of the rule group. namePrefix Creates a unique name beginning with the specified prefix. Conflicts with name. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. rules The rule blocks used to identify the web requests that you want to allow, block, or count. See Rules below for details. rulesJson Raw JSON string to allow more than three nested statements. Conflicts with rule attribute. This is for advanced use cases where more than 3 levels of nested statements are required. There is no drift detection at this time. If you use this attribute instead of rule, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration with rulesJson set will result in a one time in-place update as the remote rule configuration is initially written to the rule attribute. See the AWS documentation for the JSON structure. scope Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider. tags An array of key:value pairs to associate with the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. visibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. See Visibility Configuration below for details.
const
RuleGroupArgs.fromMap(Map<String, dynamic> map)
factory

Properties

capacity → Input<int>
The web ACL capacity units (WCUs) required for this rule group. See here for general information and here for capacity specific information.
final
customResponseBodies → Input<List<RuleGroupCustomResponseBody>?>?
Defines custom response bodies that can be referenced by customResponse actions. See Custom Response Body below for details.
final
description → Input<String?>?
A friendly description of the rule group.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
A friendly name of the rule group.
final
namePrefix → Input<String?>?
Creates a unique name beginning with the specified prefix. Conflicts with name.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
rules → Input<List<RuleGroupRule>?>?
The rule blocks used to identify the web requests that you want to allow, block, or count. See Rules below for details.
final
rulesJson → Input<String?>?
Raw JSON string to allow more than three nested statements. Conflicts with rule attribute. This is for advanced use cases where more than 3 levels of nested statements are required. There is no drift detection at this time. If you use this attribute instead of rule, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration with rulesJson set will result in a one time in-place update as the remote rule configuration is initially written to the rule attribute. See the AWS documentation for the JSON structure.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → Input<String>
Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider.
final
tags → Input<Map<String, String>?>?
An array of key:value pairs to associate with the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
visibilityConfig → Input<RuleGroupVisibilityConfig>
Defines and enables Amazon CloudWatch metrics and web request sample collection. See Visibility Configuration below for details.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited