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

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::CreateWebACLRequest

Defined in:

gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #association_config ⇒ Types::AssociationConfig

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

• #captcha_config ⇒ Types::CaptchaConfig

  Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.

• #challenge_config ⇒ Types::ChallengeConfig

  Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings.

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

  A map of custom response keys and content bodies.

• #data_protection_config ⇒ Types::DataProtectionConfig

  Specifies data protection to apply to the web request data that WAF stores for the web ACL.

• #default_action ⇒ Types::DefaultAction

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

• #description ⇒ String

  A description of the web ACL that helps with identification.

• #name ⇒ String

  The name of the web ACL.

• #rules ⇒ Array<Types::Rule>

  The Rule statements used to identify the web requests that you want to manage.

• #scope ⇒ String

  Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.

• #tags ⇒ Array<Types::Tag>

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

• #token_domains ⇒ Array<String>

  Specifies the domains that WAF should accept in a web request token.

• #visibility_config ⇒ Types::VisibilityConfig

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

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

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

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

Returns:

• (Types::AssociationConfig)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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:

• (Types::CaptchaConfig)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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:

• (Types::ChallengeConfig)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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 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.

Returns:

• (Hash<String,Types::CustomResponseBody>)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

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

#data_protection_config ⇒ Types::DataProtectionConfig

Specifies data protection to apply to the web request data that WAF stores for the web ACL. This is a web ACL level data protection option.

The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including WAF logging, web ACL request sampling, Amazon Web Services Managed Rules, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.

Returns:

• (Types::DataProtectionConfig)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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:

• (Types::DefaultAction)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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:

• (Array<Types::Rule>)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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 a global resource type, such as a Amazon CloudFront distribution.

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)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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>)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

class CreateWebACLRequest < Struct.new(
  :name,
  :scope,
  :default_action,
  :description,
  :rules,
  :visibility_config,
  :data_protection_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:

• (Types::VisibilityConfig)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1507

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