WebAclRule class

Constructors

WebAclRule({Input<WebAclRuleAction?>? action, Input<WebAclRuleCaptchaConfig?>? captchaConfig, Input<WebAclRuleChallengeConfig?>? challengeConfig, required Input<String> name, Input<WebAclRuleOverrideAction?>? overrideAction, required Input<int> priority, Input<List<WebAclRuleRuleLabel>?>? ruleLabels, required Input<WebAclRuleStatement> statement, required Input<WebAclRuleVisibilityConfig> visibilityConfig})
Creates a new WebAclRule. action Action that AWS WAF should take on a web request when it matches the rule's statement. This is used only for rules whose statements do not reference a rule group. See action for details. captchaConfig Specifies how AWS WAF should handle CAPTCHA evaluations. See captchaConfig below for details. challengeConfig Specifies how AWS WAF should handle Challenge evaluations on the rule level. See challengeConfig below for details. name Friendly name of the rule. Note that the provider assumes that rules with names matching this pattern, ^ShieldMitigationRuleGroup_&lt;account-id&gt;_&lt;web-acl-guid&gt;_.*, are AWS-added for automatic application layer DDoS mitigation activities. Such rules will be ignored by the provider unless you explicitly include them in your configuration (for example, by using the AWS CLI to discover their properties and creating matching configuration). However, since these rules are owned and managed by AWS, you may get permission errors. overrideAction Override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like ruleGroupReferenceStatement and managedRuleGroupStatement. See overrideAction below for details. priority If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. ruleLabels Labels to apply to web requests that match the rule match statement. See ruleLabel below for details. statement The AWS WAF processing statement for the rule, for example byteMatchStatement or geoMatchStatement. See statement below for details. visibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. See visibilityConfig below for details.
const
WebAclRule.fromMap(Map<String, dynamic> map)
factory

Properties

action → Input<WebAclRuleAction?>?
Action that AWS WAF should take on a web request when it matches the rule's statement. This is used only for rules whose statements do not reference a rule group. See action for details.
final
captchaConfig → Input<WebAclRuleCaptchaConfig?>?
Specifies how AWS WAF should handle CAPTCHA evaluations. See captchaConfig below for details.
final
challengeConfig → Input<WebAclRuleChallengeConfig?>?
Specifies how AWS WAF should handle Challenge evaluations on the rule level. See challengeConfig below for details.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String>
Friendly name of the rule. Note that the provider assumes that rules with names matching this pattern, ^ShieldMitigationRuleGroup_&lt;account-id&gt;_&lt;web-acl-guid&gt;_.*, are AWS-added for automatic application layer DDoS mitigation activities. Such rules will be ignored by the provider unless you explicitly include them in your configuration (for example, by using the AWS CLI to discover their properties and creating matching configuration). However, since these rules are owned and managed by AWS, you may get permission errors.
final
overrideAction → Input<WebAclRuleOverrideAction?>?
Override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like ruleGroupReferenceStatement and managedRuleGroupStatement. See overrideAction below for details.
final
priority → Input<int>
If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first.
final
ruleLabels → Input<List<WebAclRuleRuleLabel>?>?
Labels to apply to web requests that match the rule match statement. See ruleLabel below for details.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
statement → Input<WebAclRuleStatement>
The AWS WAF processing statement for the rule, for example byteMatchStatement or geoMatchStatement. See statement below for details.
final
visibilityConfig → Input<WebAclRuleVisibilityConfig>
Defines and enables Amazon CloudWatch metrics and web request sample collection. See visibilityConfig 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