Class: Aws::WAFV2::Types::CreateWebACLRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-wafv2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#association_config ⇒ Types::AssociationConfig

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

<note markdown=“1”> You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [WAF Pricing].

</note>

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

[1]: aws.amazon.com/waf/pricing/

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#captcha_config ⇒ Types::CaptchaConfig

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`.

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#challenge_config ⇒ Types::ChallengeConfig

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`.

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#custom_response_bodies ⇒ Hash<String,Types::CustomResponseBody>

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][1

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*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html [2]: docs.aws.amazon.com/waf/latest/developerguide/limits.html

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#default_action ⇒ Types::DefaultAction

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

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the web ACL that helps with identification.

Returns:

  • (String) 


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::Rule>

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

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.

Returns:

  • (String) 


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#token_domains ⇒ Array<String>

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 ‘gov.au` or `co.uk` as token domains.

Returns:

  • (Array<String>) 


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_config ⇒ Types::VisibilityConfig

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

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1513

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies,
  :captcha_config,
  :challenge_config,
  :token_domains,
  :association_config)
  SENSITIVE = []
  include Aws::Structure
end