Class: Aws::WAFV2::Types::RuleAction

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

Overview

Note:

When making an API call, you may pass RuleAction data as a hash:

{
  block: {
    custom_response: {
      response_code: 1, # required
      custom_response_body_key: "EntityName",
      response_headers: [
        {
          name: "CustomHTTPHeaderName", # required
          value: "CustomHTTPHeaderValue", # required
        },
      ],
    },
  },
  allow: {
    custom_request_handling: {
      insert_headers: [ # required
        {
          name: "CustomHTTPHeaderName", # required
          value: "CustomHTTPHeaderValue", # required
        },
      ],
    },
  },
  count: {
    custom_request_handling: {
      insert_headers: [ # required
        {
          name: "CustomHTTPHeaderName", # required
          value: "CustomHTTPHeaderValue", # required
        },
      ],
    },
  },
  captcha: {
    custom_request_handling: {
      insert_headers: [ # required
        {
          name: "CustomHTTPHeaderName", # required
          value: "CustomHTTPHeaderValue", # required
        },
      ],
    },
  },
  challenge: {
    custom_request_handling: {
      insert_headers: [ # required
        {
          name: "CustomHTTPHeaderName", # required
          value: "CustomHTTPHeaderValue", # required
        },
      ],
    },
  },
}

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow ⇒ Types::AllowAction

Instructs WAF to allow the web request.

Returns:



12232
12233
12234
12235
12236
12237
12238
12239
12240
 
# File 'lib/aws-sdk-wafv2/types.rb', line 12232

class RuleAction < Struct.new(
  :block,
  :allow,
  :count,
  :captcha,
  :challenge)
  SENSITIVE = []
  include Aws::Structure
end

#block ⇒ Types::BlockAction

Instructs WAF to block the web request.

Returns:



12232
12233
12234
12235
12236
12237
12238
12239
12240
 
# File 'lib/aws-sdk-wafv2/types.rb', line 12232

class RuleAction < Struct.new(
  :block,
  :allow,
  :count,
  :captcha,
  :challenge)
  SENSITIVE = []
  include Aws::Structure
end

#captcha ⇒ Types::CaptchaAction

Instructs WAF to run a `CAPTCHA` check against the web request.

Returns:



12232
12233
12234
12235
12236
12237
12238
12239
12240
 
# File 'lib/aws-sdk-wafv2/types.rb', line 12232

class RuleAction < Struct.new(
  :block,
  :allow,
  :count,
  :captcha,
  :challenge)
  SENSITIVE = []
  include Aws::Structure
end

#challenge ⇒ Types::ChallengeAction

Instructs WAF to run a `Challenge` check against the web request.

Returns:



12232
12233
12234
12235
12236
12237
12238
12239
12240
 
# File 'lib/aws-sdk-wafv2/types.rb', line 12232

class RuleAction < Struct.new(
  :block,
  :allow,
  :count,
  :captcha,
  :challenge)
  SENSITIVE = []
  include Aws::Structure
end

#count ⇒ Types::CountAction

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Returns:



12232
12233
12234
12235
12236
12237
12238
12239
12240
 
# File 'lib/aws-sdk-wafv2/types.rb', line 12232

class RuleAction < Struct.new(
  :block,
  :allow,
  :count,
  :captcha,
  :challenge)
  SENSITIVE = []
  include Aws::Structure
end