WebACL class
A Web ACL defines a collection of rules to use to inspect and control web
requests. Each rule has an action defined (allow, block, or count) for
requests that match the statement of the rule. In the Web ACL, you assign a
default action to take (allow, block) for any request that does not match
any of the rules. The rules in a Web ACL can be a combination of the types
Rule, RuleGroup, and managed rule group. You can associate a
Web ACL with one or more AWS resources to protect. The resources can be
Amazon CloudFront, an Amazon API Gateway REST API, an Application Load
Balancer, or an AWS AppSync GraphQL API.
Constructors
-
WebACL({required String arn, required DefaultAction defaultAction, required String id, required String name, required VisibilityConfig visibilityConfig, int? capacity, String? description, bool? managedByFirewallManager, List<
FirewallManagerRuleGroup> ? postProcessFirewallManagerRuleGroups, List<FirewallManagerRuleGroup> ? preProcessFirewallManagerRuleGroups, List<Rule> ? rules}) -
WebACL.fromJson(Map<
String, dynamic> json) -
factory
Properties
- arn → String
-
The Amazon Resource Name (ARN) of the Web ACL that you want to associate
with the resource.
final
- capacity → int?
-
The web ACL capacity units (WCUs) currently being used by this web ACL.
final
- defaultAction → DefaultAction
-
The action to perform if none of the
Rules
contained in theWebACL
match.final - description → String?
-
A description of the Web ACL that helps with identification. You cannot
change the description of a Web ACL after you create it.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
A unique identifier for the
WebACL
. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete aWebACL
.final - managedByFirewallManager → bool?
-
Indicates whether this web ACL is managed by AWS Firewall Manager. If true,
then only AWS Firewall Manager can delete the web ACL or any Firewall
Manager rule groups in the web ACL.
final
- name → String
-
The name of the Web ACL. You cannot change the name of a Web ACL after you
create it.
final
-
postProcessFirewallManagerRuleGroups
→ List<
FirewallManagerRuleGroup> ? -
The last set of rules for AWS WAF to process in the web ACL. This is defined
in an AWS Firewall Manager WAF policy and contains only rule group
references. You can't alter these. Any rules and rule groups that you define
for the web ACL are prioritized before these.
final
-
preProcessFirewallManagerRuleGroups
→ List<
FirewallManagerRuleGroup> ? -
The first set of rules for AWS WAF to process in the web ACL. This is
defined in an AWS Firewall Manager WAF policy and contains only rule group
references. You can't alter these. Any rules and rule groups that you define
for the web ACL are prioritized after these.
final
-
rules
→ List<
Rule> ? -
The Rule statements used to identify the web requests that you want
to allow, block, or count. Each rule includes one top-level statement that
AWS WAF uses to identify matching web requests, and parameters that govern
how AWS WAF handles them.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- visibilityConfig → VisibilityConfig
-
Defines and enables Amazon CloudWatch metrics and web request sample
collection.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited