WebAclState class
Input properties used for looking up and filtering WebAcl resources.
Constructors
-
WebAclState({Input<
String?> ? applicationIntegrationUrl, Input<String?> ? arn, Input<WebAclAssociationConfig?> ? associationConfig, Input<int?> ? capacity, Input<WebAclCaptchaConfig?> ? captchaConfig, Input<WebAclChallengeConfig?> ? challengeConfig, Input<List< ? customResponseBodies, Input<WebAclCustomResponseBody> ?>WebAclDataProtectionConfig?> ? dataProtectionConfig, Input<WebAclDefaultAction?> ? defaultAction, Input<String?> ? description, Input<String?> ? lockToken, Input<String?> ? name, Input<String?> ? namePrefix, Input<String?> ? region, Input<String?> ? ruleJson, Input<List< ? rules, Input<WebAclRule> ?>String?> ? scope, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>List< ? tokenDomains, Input<String> ?>WebAclVisibilityConfig?> ? visibilityConfig}) -
Creates a new WebAclState.
applicationIntegrationUrlThe URL to use in SDK integrations with managed rule groups.arnThe ARN of the WAF WebACL.associationConfigSpecifies custom configurations for the associations between the web ACL and protected resources. SeeassociationConfigbelow for details.capacityWeb ACL capacity units (WCUs) currently being used by this web ACL.captchaConfigSpecifies how AWS WAF should handle CAPTCHA evaluations on the ACL level (used by AWS Bot Control). SeecaptchaConfigbelow for details.challengeConfigSpecifies how AWS WAF should handle Challenge evaluations on the ACL level (used by AWS Bot Control). SeechallengeConfigbelow for details.customResponseBodiesDefines custom response bodies that can be referenced bycustomResponseactions. SeecustomResponseBodybelow for details.dataProtectionConfigSpecifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option. SeedataProtectionConfigbelow for details.defaultActionAction to perform if none of therulescontained in the WebACL match. SeedefaultActionbelow for details.descriptionFriendly description of the WebACL.lockTokenOptional.nameFriendly name of the WebACL. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.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.ruleJsonRaw 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 web ACL into a configuration withruleJsonset 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.rulesruleblocks in this resource have several known limitations. Consider usingaws.wafv2.WebAclRuleto manage rules as separate resources instead. Rule blocks used to identify the web requests that you want toallow,block, orcount. Seerulebelow for details.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.tagsMap 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.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.tokenDomainsSpecifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.visibilityConfigDefines and enables Amazon CloudWatch metrics and web request sample collection. SeevisibilityConfigbelow for details.const -
WebAclState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
applicationIntegrationUrl
→ Input<
String?> ? -
The URL to use in SDK integrations with managed rule groups.
final
-
arn
→ Input<
String?> ? -
The ARN of the WAF WebACL.
final
-
associationConfig
→ Input<
WebAclAssociationConfig?> ? -
Specifies custom configurations for the associations between the web ACL and protected resources. See
associationConfigbelow for details.final -
capacity
→ Input<
int?> ? -
Web ACL capacity units (WCUs) currently being used by this web ACL.
final
-
captchaConfig
→ Input<
WebAclCaptchaConfig?> ? -
Specifies how AWS WAF should handle CAPTCHA evaluations on the ACL level (used by AWS Bot Control). See
captchaConfigbelow for details.final -
challengeConfig
→ Input<
WebAclChallengeConfig?> ? -
Specifies how AWS WAF should handle Challenge evaluations on the ACL level (used by AWS Bot Control). See
challengeConfigbelow for details.final -
customResponseBodies
→ Input<
List< ?WebAclCustomResponseBody> ?> -
Defines custom response bodies that can be referenced by
customResponseactions. SeecustomResponseBodybelow for details.final -
dataProtectionConfig
→ Input<
WebAclDataProtectionConfig?> ? -
Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option. See
dataProtectionConfigbelow for details.final -
defaultAction
→ Input<
WebAclDefaultAction?> ? -
Action to perform if none of the
rulescontained in the WebACL match. SeedefaultActionbelow for details.final -
description
→ Input<
String?> ? -
Friendly description of the WebACL.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
lockToken
→ Input<
String?> ? -
final
-
name
→ Input<
String?> ? -
Friendly name of the WebACL. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.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
-
ruleJson
→ 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 web ACL into a configuration withruleJsonset 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 -
rules
→ Input<
List< ?WebAclRule> ?> -
ruleblocks in this resource have several known limitations. Consider usingaws.wafv2.WebAclRuleto manage rules as separate resources instead. Rule blocks used to identify the web requests that you want toallow,block, orcount. Seerulebelow for details.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 -
Map 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 -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
tokenDomains
→ Input<
List< ?String> ?> -
Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
final
-
visibilityConfig
→ Input<
WebAclVisibilityConfig?> ? -
Defines and enables Amazon CloudWatch metrics and web request sample collection. See
visibilityConfigbelow 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