Class: Ansible::Ruby::Modules::Aws_waf_web_acl

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb

Overview

Read the AWS documentation for WAF U(aws.amazon.com/documentation/waf/)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#default_action ⇒ :block, ...

Returns The action that you want AWS WAF to take when a request doesn’t match the criteria specified in any of the Rule objects that are associated with the WebACL.

Returns:

  • (:block, :allow, :count, nil) —

    The action that you want AWS WAF to take when a request doesn’t match the criteria specified in any of the Rule objects that are associated with the WebACL



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb', line 16

attribute :default_action

#metric_name ⇒ Object?

Returns 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 metric_name after you create the WebACL,Metric name will default to I(name) with disallowed characters stripped out.

Returns:

  • (Object, nil) —

    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 metric_name after you create the WebACL,Metric name will default to I(name) with disallowed characters stripped out



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb', line 24

attribute :metric_name

#name ⇒ String

Returns Name of the Web Application Firewall ACL to manage.

Returns:

  • (String) —

    Name of the Web Application Firewall ACL to manage



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb', line 12

attribute :name

#purge_rules ⇒ Boolean?

Returns Whether to remove rules that aren’t passed with C(rules). Defaults to false.

Returns:

  • (Boolean, nil) —

    Whether to remove rules that aren’t passed with C(rules). Defaults to false



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb', line 31

attribute :purge_rules

#rules ⇒ Array<Hash>, ...

Returns A list of rules that the Web ACL will enforce.,Each rule must contain I(name), I(action), I(priority) keys.,Priorities must be unique, but not necessarily consecutive. Lower numbered priorities are evalauted first.,The I(type) key can be passed as C(rate_based), it defaults to C(regular).

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of rules that the Web ACL will enforce.,Each rule must contain I(name), I(action), I(priority) keys.,Priorities must be unique, but not necessarily consecutive. Lower numbered priorities are evalauted first.,The I(type) key can be passed as C(rate_based), it defaults to C(regular)



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb', line 27

attribute :rules

#state ⇒ :present, ...

Returns whether the Web ACL should be present or absent.

Returns:

  • (:present, :absent, nil) —

    whether the Web ACL should be present or absent



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_web_acl.rb', line 20

attribute :state