aws.wafv2.WebAcl

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.

Create WebAcl Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WebAcl(name: string, args: WebAclArgs, opts?: CustomResourceOptions);

@overload
def WebAcl(resource_name: str,
           args: WebAclArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def WebAcl(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           association_config: Optional[WebAclAssociationConfigArgs] = None,
           captcha_config: Optional[WebAclCaptchaConfigArgs] = None,
           challenge_config: Optional[WebAclChallengeConfigArgs] = None,
           custom_response_bodies: Optional[Sequence[WebAclCustomResponseBodyArgs]] = None,
           data_protection_config: Optional[WebAclDataProtectionConfigArgs] = None,
           default_action: Optional[WebAclDefaultActionArgs] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           name_prefix: Optional[str] = None,
           region: Optional[str] = None,
           rule_json: Optional[str] = None,
           rules: Optional[Sequence[WebAclRuleArgs]] = None,
           scope: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           token_domains: Optional[Sequence[str]] = None,
           visibility_config: Optional[WebAclVisibilityConfigArgs] = None)

func NewWebAcl(ctx *Context, name string, args WebAclArgs, opts ...ResourceOption) (*WebAcl, error)

public WebAcl(string name, WebAclArgs args, CustomResourceOptions? opts = null)

public WebAcl(String name, WebAclArgs args)
public WebAcl(String name, WebAclArgs args, CustomResourceOptions options)

type: aws:wafv2:WebAcl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "aws_wafv2_webacl" "name" {
    # resource properties
}

Parameters

WebAcl Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The WebAcl resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the WebAcl resource produces the following output properties:

Look up Existing WebAcl Resource

Get an existing WebAcl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WebAclState, opts?: CustomResourceOptions): WebAcl

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_integration_url: Optional[str] = None,
        arn: Optional[str] = None,
        association_config: Optional[WebAclAssociationConfigArgs] = None,
        capacity: Optional[int] = None,
        captcha_config: Optional[WebAclCaptchaConfigArgs] = None,
        challenge_config: Optional[WebAclChallengeConfigArgs] = None,
        custom_response_bodies: Optional[Sequence[WebAclCustomResponseBodyArgs]] = None,
        data_protection_config: Optional[WebAclDataProtectionConfigArgs] = None,
        default_action: Optional[WebAclDefaultActionArgs] = None,
        description: Optional[str] = None,
        lock_token: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        region: Optional[str] = None,
        rule_json: Optional[str] = None,
        rules: Optional[Sequence[WebAclRuleArgs]] = None,
        scope: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        token_domains: Optional[Sequence[str]] = None,
        visibility_config: Optional[WebAclVisibilityConfigArgs] = None) -> WebAcl

func GetWebAcl(ctx *Context, name string, id IDInput, state *WebAclState, opts ...ResourceOption) (*WebAcl, error)

public static WebAcl Get(string name, Input<string> id, WebAclState? state, CustomResourceOptions? opts = null)

public static WebAcl get(String name, Output<String> id, WebAclState state, CustomResourceOptions options)

resources:  _:    type: aws:wafv2:WebAcl    get:      id: ${id}

import {
  to = aws_wafv2_webacl.example
  id = "${id}"
}

Supporting Types

Note: There are over 200 nested types for this resource. Only the first 200 types are included in this documentation.

WebAclAssociationConfig, WebAclAssociationConfigArgs

WebAclAssociationConfigRequestBody, WebAclAssociationConfigRequestBodyArgs

WebAclAssociationConfigRequestBodyApiGateway, WebAclAssociationConfigRequestBodyApiGatewayArgs

WebAclAssociationConfigRequestBodyAppRunnerService, WebAclAssociationConfigRequestBodyAppRunnerServiceArgs

WebAclAssociationConfigRequestBodyCloudfront, WebAclAssociationConfigRequestBodyCloudfrontArgs

WebAclAssociationConfigRequestBodyCognitoUserPool, WebAclAssociationConfigRequestBodyCognitoUserPoolArgs

WebAclAssociationConfigRequestBodyVerifiedAccessInstance, WebAclAssociationConfigRequestBodyVerifiedAccessInstanceArgs

WebAclCaptchaConfig, WebAclCaptchaConfigArgs

WebAclCaptchaConfigImmunityTimeProperty, WebAclCaptchaConfigImmunityTimePropertyArgs

WebAclChallengeConfig, WebAclChallengeConfigArgs

WebAclChallengeConfigImmunityTimeProperty, WebAclChallengeConfigImmunityTimePropertyArgs

WebAclCustomResponseBody, WebAclCustomResponseBodyArgs

WebAclDataProtectionConfig, WebAclDataProtectionConfigArgs

WebAclDataProtectionConfigDataProtection, WebAclDataProtectionConfigDataProtectionArgs

WebAclDataProtectionConfigDataProtectionField, WebAclDataProtectionConfigDataProtectionFieldArgs

WebAclDefaultAction, WebAclDefaultActionArgs

WebAclDefaultActionAllow, WebAclDefaultActionAllowArgs

WebAclDefaultActionAllowCustomRequestHandling, WebAclDefaultActionAllowCustomRequestHandlingArgs

WebAclDefaultActionAllowCustomRequestHandlingInsertHeader, WebAclDefaultActionAllowCustomRequestHandlingInsertHeaderArgs

WebAclDefaultActionBlock, WebAclDefaultActionBlockArgs

WebAclDefaultActionBlockCustomResponse, WebAclDefaultActionBlockCustomResponseArgs

WebAclDefaultActionBlockCustomResponseResponseHeader, WebAclDefaultActionBlockCustomResponseResponseHeaderArgs

WebAclRule, WebAclRuleArgs