WebAcl class
Creates a WAFv2 Web ACL resource.
> Note: Inline rule blocks in this resource have several known limitations. Consider using aws.wafv2.WebAclRule to manage rules as separate resources instead. Limitations include: Deletion ordering errors: When removing a rule that references an IP set or rule group, AWS requires the rule to be detached before the referenced resource is deleted. Terraform's dependency graph cannot model this correctly for inline rules, resulting in WAFAssociatedItemException errors. Spurious diffs: AWS returns rules in an unpredictable order, which can cause Terraform to detect changes even when the configuration has not changed. Coupled updates: Modifying one inline rule may cause all rules to be recreated, which can be disruptive.
> Warning: If you use the aws.wafv2.WebAclRule or aws.wafv2.WebAclRuleGroupAssociation resources with this Web ACL, you must add lifecycle { ignoreChanges = [rule] } to this resource to prevent configuration drift. Those resources manage the Web ACL's rules outside of this resource's direct management.
Import
Using pulumi import, import WAFv2 Web ACLs using ID/Name/Scope. For example:
$ pulumi import aws:wafv2/webAcl:WebAcl example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL
Constructors
- WebAcl(String name, {WebAclArgs? args, CustomResourceOptions? options})
-
Creates a new WebAcl.
nameThe Pulumi resource name.argsArguments used to configure this WebAcl. The set of arguments for WebAcl.optionsResource options controlling this resource's behavior. - WebAcl.reference(String urn)
- Creates a typed reference to an existing WebAcl resource.
Properties
-
applicationIntegrationUrl
↔ Output<
String> -
The URL to use in SDK integrations with managed rule groups.
latefinal
-
arn
↔ Output<
String> -
The ARN of the WAF WebACL.
latefinal
-
associationConfig
↔ Output<
WebAclAssociationConfig?> -
Specifies custom configurations for the associations between the web ACL and protected resources. See
associationConfigbelow for details.latefinal -
capacity
↔ Output<
int> -
Web ACL capacity units (WCUs) currently being used by this web ACL.
latefinal
-
captchaConfig
↔ Output<
WebAclCaptchaConfig?> -
Specifies how AWS WAF should handle CAPTCHA evaluations on the ACL level (used by AWS Bot Control). See
captchaConfigbelow for details.latefinal -
challengeConfig
↔ Output<
WebAclChallengeConfig?> -
Specifies how AWS WAF should handle Challenge evaluations on the ACL level (used by AWS Bot Control). See
challengeConfigbelow for details.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
customResponseBodies
↔ Output<
List< WebAclCustomResponseBody> ?> -
Defines custom response bodies that can be referenced by
customResponseactions. SeecustomResponseBodybelow for details.latefinal -
dataProtectionConfig
↔ Output<
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.latefinal -
defaultAction
↔ Output<
WebAclDefaultAction> -
Action to perform if none of the
rulescontained in the WebACL match. SeedefaultActionbelow for details.latefinal -
description
↔ Output<
String?> -
Friendly description of the WebACL.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lockToken
↔ Output<
String> -
latefinal
-
name
↔ Output<
String> -
Friendly name of the WebACL. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.latefinal -
namePrefix
↔ Output<
String> -
Creates a unique name beginning with the specified prefix. Conflicts with
name.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
ruleJson
↔ Output<
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.latefinal -
rules
↔ Output<
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.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scope
↔ Output<
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.latefinal -
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.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
tokenDomains
↔ Output<
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.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
visibilityConfig
↔ Output<
WebAclVisibilityConfig> -
Defines and enables Amazon CloudWatch metrics and web request sample collection. See
visibilityConfigbelow for details.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited