Class: Aws::WAFV2::Types::ClientSideAction

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

Overview

This is part of the ‘AWSManagedRulesAntiDDoSRuleSet` `ClientSideActionConfig` configuration in `ManagedRuleGroupConfig`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exempt_uri_regular_expressions ⇒ Array<Types::Regex>

The regular expression to match against the web request URI, used to identify requests that can’t handle a silent browser challenge. When the ‘ClientSideAction` setting `UsageOfAction` is enabled, the managed rule group uses this setting to determine which requests to label with `awswaf:managed:aws:anti-ddos:challengeable-request`. If `UsageOfAction` is disabled, this setting has no effect and the managed rule group doesn’t add the label to any requests.

The anti-DDoS managed rule group doesn’t evaluate the rules ‘ChallengeDDoSRequests` or `ChallengeAllDuringEvent` for web requests whose URIs match this regex. This is true regardless of whether you override the rule action for either of the rules in your web ACL configuration.

Amazon Web Services recommends using a regular expression.

This setting is required if ‘UsageOfAction` is set to `ENABLED`. If required, you can provide between 1 and 5 regex objects in the array of settings.

Amazon Web Services recommends starting with the following setting. Review and update it for your application’s needs:

‘/api/|.(acc|avi|css|gif|jpe?g|js|mp|ogg|otf|pdf|png|tiff?|ttf|webm|webp|woff2?)$`

Returns:



1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1173

class ClientSideAction < Struct.new(
  :usage_of_action,
  :sensitivity,
  :exempt_uri_regular_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#sensitivity ⇒ String

The sensitivity that the rule group rule ‘ChallengeDDoSRequests` uses when matching against the DDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the `ChallengeDDoSRequests` rule runs.

The higher the sensitivity, the more levels of labeling that the rule matches:

  • Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label ‘awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request`.

  • Medium sensitivity causes the rule to match on the medium and high suspicion labels.

  • High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.

Default: ‘HIGH`

Returns:

  • (String) 


1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1173

class ClientSideAction < Struct.new(
  :usage_of_action,
  :sensitivity,
  :exempt_uri_regular_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#usage_of_action ⇒ String

Determines whether to use the ‘AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the rule group evaluation and the related label `awswaf:managed:aws:anti-ddos:challengeable-request`.

  • If usage is enabled:

    • The managed rule group adds the label ‘awswaf:managed:aws:anti-ddos:challengeable-request` to any web request whose URL does NOT match the regular expressions provided in the `ClientSideAction` setting `ExemptUriRegularExpressions`.

    • The two rules are evaluated against web requests for protected resources that are experiencing a DDoS attack. The two rules only apply their action to matching requests that have the label ‘awswaf:managed:aws:anti-ddos:challengeable-request`.

  • If usage is disabled:

    • The managed rule group doesn’t add the label ‘awswaf:managed:aws:anti-ddos:challengeable-request` to any web requests.

    • The two rules are not evaluated.

    • None of the other ‘ClientSideAction` settings have any effect.

<note markdown=“1”> This setting only enables or disables the use of the two anti-DDOS rules ‘ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the anti-DDoS managed rule group.

This setting doesn't alter the action setting in the two rules. To

override the actions used by the rules ‘ChallengeAllDuringEvent` and `ChallengeDDoSRequests`, enable this setting, and then override the rule actions in the usual way, in your managed rule group configuration.

</note>

Returns:

  • (String) 


1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1173

class ClientSideAction < Struct.new(
  :usage_of_action,
  :sensitivity,
  :exempt_uri_regular_expressions)
  SENSITIVE = []
  include Aws::Structure
end