CreateWebACLRequest

import type { CreateWebACLRequest } from "https://aws-api.deno.dev/v0.4/services/wafv2.ts?docs=full";

interface CreateWebACLRequest {

CaptchaConfig?: CaptchaConfig | null;

ChallengeConfig?: ChallengeConfig | null;

CustomResponseBodies?: {

[key: string]: CustomResponseBody | null | undefined;

} | null;

DefaultAction: DefaultAction;

Description?: string | null;

Name: string;

Rules?: Rule[] | null;

Scope: Scope;

Tags?: Tag[] | null;

TokenDomains?: string[] | null;

VisibilityConfig: VisibilityConfig;

}

§Properties

CaptchaConfig?: CaptchaConfig | null

[src]

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

ChallengeConfig?: ChallengeConfig | null

[src]

Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

CustomResponseBodies?: {

[key: string]: CustomResponseBody | null | undefined;

} | null

[src]

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

DefaultAction: DefaultAction

[src]

The action to perform if none of the Rules contained in the WebACL match.

Description?: string | null

[src]

A description of the web ACL that helps with identification.

Name: string

[src]

The name of the web ACL. You cannot change the name of a web ACL after you create it.

Rules?: Rule[] | null

[src]

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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Scope: Scope

[src]

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.

Tags?: Tag[] | null

[src]

An array of key:value pairs to associate with the resource.

TokenDomains?: string[] | null

[src]

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

VisibilityConfig: VisibilityConfig

[src]

Defines and enables Amazon CloudWatch metrics and web request sample collection.