RuleGroupState class
Input properties used for looking up and filtering RuleGroup resources.
Constructors
-
RuleGroupState({Input<
String?> ? arn, Input<int?> ? capacity, Input<List< ? customResponseBodies, Input<RuleGroupCustomResponseBody> ?>String?> ? description, Input<String?> ? lockToken, Input<String?> ? name, Input<String?> ? namePrefix, Input<String?> ? region, Input<List< ? rules, Input<RuleGroupRule> ?>String?> ? rulesJson, Input<String?> ? scope, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>RuleGroupVisibilityConfig?> ? visibilityConfig}) -
Creates a new RuleGroupState.
arnThe ARN of the WAF rule group.capacityThe web ACL capacity units (WCUs) required for this rule group. See here for general information and here for capacity specific information.customResponseBodiesDefines custom response bodies that can be referenced bycustomResponseactions. See Custom Response Body below for details.descriptionA friendly description of the rule group.lockTokenOptional.nameA friendly name of the rule group.namePrefixCreates a unique name beginning with the specified prefix. Conflicts withname.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.rulesThe rule blocks used to identify the web requests that you want toallow,block, orcount. See Rules below for details.rulesJsonRaw JSON string to allow more than three nested statements. Conflicts withruleattribute. 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 ofrule, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration withrulesJsonset will result in a one time in-place update as the remote rule configuration is initially written to theruleattribute. See the AWS documentation for the JSON structure.scopeSpecifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values areCLOUDFRONTorREGIONAL. To work with CloudFront, you must also specify the regionus-east-1(N. Virginia) on the AWS provider.tagsAn array of key:value pairs to associate with the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.visibilityConfigDefines and enables Amazon CloudWatch metrics and web request sample collection. See Visibility Configuration below for details.const -
RuleGroupState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
The ARN of the WAF rule group.
final
-
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
customResponseactions. 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
-
lockToken
→ Input<
String?> ? -
final
-
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, orcount. See Rules below for details.final -
rulesJson
→ Input<
String?> ? -
Raw JSON string to allow more than three nested statements. Conflicts with
ruleattribute. 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 ofrule, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration withrulesJsonset will result in a one time in-place update as the remote rule configuration is initially written to theruleattribute. 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
CLOUDFRONTorREGIONAL. To work with CloudFront, you must also specify the regionus-east-1(N. Virginia) on the AWS provider.final -
An array of key:value pairs to associate with the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.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