Class: Aws::WAFV2::Types::UpdateWebACLRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WAFV2::Types::UpdateWebACLRequest
- Defined in:
- gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 ownCaptchaConfig
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.
-
#default_action ⇒ Types::DefaultAction
The action to perform if none of the
Rules
contained in theWebACL
match. -
#description ⇒ String
A description of the web ACL that helps with identification.
-
#id ⇒ String
The unique identifier for the web ACL.
-
#lock_token ⇒ String
A token used for optimistic locking.
-
#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 an Amazon CloudFront distribution or for a regional application.
-
#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).
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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
.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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
.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :custom_response_bodies, :captcha_config, :challenge_config, :token_domains, :association_config) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :custom_response_bodies, :captcha_config, :challenge_config, :token_domains, :association_config) SENSITIVE = [] include Aws::Structure end |
#lock_token ⇒ String
A token used for optimistic locking. WAF returns a token to your
get
and list
requests, to mark the state of the entity at the
time of the request. To make changes to the entity associated with
the token, you provide the token to operations like update
and
delete
. WAF uses the token to ensure that no changes have been
made to the entity since you last retrieved it. If a change has been
made, the update fails with a WAFOptimisticLockException
. If this
happens, perform another get
, and use the new token returned by
that operation.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :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.
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9233 class UpdateWebACLRequest < Struct.new( :name, :scope, :id, :default_action, :description, :rules, :visibility_config, :lock_token, :custom_response_bodies, :captcha_config, :challenge_config, :token_domains, :association_config) SENSITIVE = [] include Aws::Structure end |