Class: Ansible::Ruby::Modules::Aws_waf_rule

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_rule.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

#conditions ⇒ Array<Hash>, ...

Returns list of conditions used in the rule. Each condition should contain I(type): which is one of [C(byte), C(geo), C(ip), C(size), C(sql) or C(xss)] I(negated): whether the condition should be negated, and C(condition), the name of the existing condition. M(aws_waf_condition) can be used to create new conditionsrn.

Returns:

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

    list of conditions used in the rule. Each condition should contain I(type): which is one of [C(byte), C(geo), C(ip), C(size), C(sql) or C(xss)] I(negated): whether the condition should be negated, and C(condition), the name of the existing condition. M(aws_waf_condition) can be used to create new conditionsrn



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_rule.rb', line 23

attribute :conditions

#metric_name ⇒ Object?

Returns A friendly name or description for the metrics for the rule,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 rule,Defaults to the same as name with disallowed characters removed.

Returns:

  • (Object, nil) —

    A friendly name or description for the metrics for the rule,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 rule,Defaults to the same as name with disallowed characters removed



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

attribute :metric_name

#name ⇒ String

Returns Name of the Web Application Firewall rule.

Returns:

  • (String) —

    Name of the Web Application Firewall rule



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

attribute :name

#purge_conditions ⇒ Object?

Returns Whether or not to remove conditions that are not passed when updating ‘conditions`. Defaults to false.

Returns:

  • (Object, nil) —

    Whether or not to remove conditions that are not passed when updating ‘conditions`. Defaults to false.



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

attribute :purge_conditions

#state ⇒ :present, ...

Returns whether the rule should be present or absent.

Returns:

  • (:present, :absent, nil) —

    whether the rule should be present or absent



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_rule.rb', line 19

attribute :state