You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WAF::Types::ActivatedRule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb

Overview

Note:

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

{
  priority: 1, # required
  rule_id: "ResourceId", # required
  action: { # required
    type: "BLOCK", # required, accepts BLOCK, ALLOW, COUNT
  },
  type: "REGULAR", # accepts REGULAR, RATE_BASED
}

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

Instance Attribute Summary collapse

Instance Attribute Details

#actionTypes::WafAction

Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

  • ALLOW: CloudFront responds with the requested object.

  • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

  • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

Returns:



74
75
76
77
78
79
80
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 74

class ActivatedRule < Struct.new(
  :priority,
  :rule_id,
  :action,
  :type)
  include Aws::Structure
end

#priorityInteger

Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

Returns:

  • (Integer)


74
75
76
77
78
79
80
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 74

class ActivatedRule < Struct.new(
  :priority,
  :rule_id,
  :action,
  :type)
  include Aws::Structure
end

#rule_idString

The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

Returns:

  • (String)


74
75
76
77
78
79
80
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 74

class ActivatedRule < Struct.new(
  :priority,
  :rule_id,
  :action,
  :type)
  include Aws::Structure
end

#typeString

The rule type, either REGULAR, as defined by Rule, or RATE_BASED, as defined by RateBasedRule. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

Returns:

  • (String)


74
75
76
77
78
79
80
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 74

class ActivatedRule < Struct.new(
  :priority,
  :rule_id,
  :action,
  :type)
  include Aws::Structure
end