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

Class: Aws::WAF::Types::WebACL

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

Overview

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

Instance Attribute Summary collapse

Instance Attribute Details

#default_actionTypes::WafAction

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

Returns:



3760
3761
3762
3763
3764
3765
3766
3767
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3760

class WebACL < Struct.new(
  :web_acl_id,
  :name,
  :metric_name,
  :default_action,
  :rules)
  include Aws::Structure
end

#metric_nameString

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

Returns:

  • (String)


3760
3761
3762
3763
3764
3765
3766
3767
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3760

class WebACL < Struct.new(
  :web_acl_id,
  :name,
  :metric_name,
  :default_action,
  :rules)
  include Aws::Structure
end

#nameString

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Returns:

  • (String)


3760
3761
3762
3763
3764
3765
3766
3767
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3760

class WebACL < Struct.new(
  :web_acl_id,
  :name,
  :metric_name,
  :default_action,
  :rules)
  include Aws::Structure
end

#rulesArray<Types::ActivatedRule>

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

Returns:



3760
3761
3762
3763
3764
3765
3766
3767
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3760

class WebACL < Struct.new(
  :web_acl_id,
  :name,
  :metric_name,
  :default_action,
  :rules)
  include Aws::Structure
end

#web_acl_idString

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

Returns:

  • (String)


3760
3761
3762
3763
3764
3765
3766
3767
# File 'gems/aws-sdk-waf/lib/aws-sdk-waf/types.rb', line 3760

class WebACL < Struct.new(
  :web_acl_id,
  :name,
  :metric_name,
  :default_action,
  :rules)
  include Aws::Structure
end