Class: Ansible::Ruby::Modules::Aws_waf_condition

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Aws_waf_condition

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/aws_waf_condition.rb

Overview

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

Instance Method Summary

• #filters ⇒ Array<Hash>, ...

  A list of the filters against which to match,For I(type)=C(byte), valid keys are C(field_to_match), C(position), C(header), C(transformation),For I(type)=C(geo), the only valid key is C(country),For I(type)=C(ip), the only valid key is C(ip_address),For I(type)=C(regex), valid keys are C(field_to_match), C(transformation) and C(regex_pattern),For I(type)=C(size), valid keys are C(field_to_match), C(transformation), C(comparison) and C(size),For I(type)=C(sql), valid keys are C(field_to_match) and C(transformation),For I(type)=C(xss), valid keys are C(field_to_match) and C(transformation),I(field_to_match) can be one of C(uri), C(query_string), C(header) C(method) and C(body),If I(field_to_match) is C(header), then C(header) must also be specified,I(transformation) can be one of C(none), C(compress_white_space), C(html_entity_decode), C(lowercase), C(cmd_line), C(url_decode),I(position), can be one of C(exactly), C(starts_with), C(ends_with), C(contains), C(contains_word),,I(comparison) can be one of C(EQ), C(NE), C(LE), C(LT), C(GE), C(GT),,I(target_string) is a maximum of 50 bytes,I(regex_pattern) is a dict with a C(name) key and C(regex_strings) list of strings to match.

• #name ⇒ String

  Name of the Web Application Firewall condition to manage.

• #purge_filters ⇒ Object^?

  Whether to remove existing filters from a condition if not passed in I(filters).

• #state ⇒ :present, ...

  Whether the condition should be C(present) or C(absent).

• #type ⇒ :byte, ...

  The type of matching to perform.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#filters ⇒ Array<Hash>, ...

Returns A list of the filters against which to match,For I(type)=C(byte), valid keys are C(field_to_match), C(position), C(header), C(transformation),For I(type)=C(geo), the only valid key is C(country),For I(type)=C(ip), the only valid key is C(ip_address),For I(type)=C(regex), valid keys are C(field_to_match), C(transformation) and C(regex_pattern),For I(type)=C(size), valid keys are C(field_to_match), C(transformation), C(comparison) and C(size),For I(type)=C(sql), valid keys are C(field_to_match) and C(transformation),For I(type)=C(xss), valid keys are C(field_to_match) and C(transformation),I(field_to_match) can be one of C(uri), C(query_string), C(header) C(method) and C(body),If I(field_to_match) is C(header), then C(header) must also be specified,I(transformation) can be one of C(none), C(compress_white_space), C(html_entity_decode), C(lowercase), C(cmd_line), C(url_decode),I(position), can be one of C(exactly), C(starts_with), C(ends_with), C(contains), C(contains_word),,I(comparison) can be one of C(EQ), C(NE), C(LE), C(LT), C(GE), C(GT),,I(target_string) is a maximum of 50 bytes,I(regex_pattern) is a dict with a C(name) key and C(regex_strings) list of strings to match.

Returns:

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

  A list of the filters against which to match,For I(type)=C(byte), valid keys are C(field_to_match), C(position), C(header), C(transformation),For I(type)=C(geo), the only valid key is C(country),For I(type)=C(ip), the only valid key is C(ip_address),For I(type)=C(regex), valid keys are C(field_to_match), C(transformation) and C(regex_pattern),For I(type)=C(size), valid keys are C(field_to_match), C(transformation), C(comparison) and C(size),For I(type)=C(sql), valid keys are C(field_to_match) and C(transformation),For I(type)=C(xss), valid keys are C(field_to_match) and C(transformation),I(field_to_match) can be one of C(uri), C(query_string), C(header) C(method) and C(body),If I(field_to_match) is C(header), then C(header) must also be specified,I(transformation) can be one of C(none), C(compress_white_space), C(html_entity_decode), C(lowercase), C(cmd_line), C(url_decode),I(position), can be one of C(exactly), C(starts_with), C(ends_with), C(contains), C(contains_word),,I(comparison) can be one of C(EQ), C(NE), C(LE), C(LT), C(GE), C(GT),,I(target_string) is a maximum of 50 bytes,I(regex_pattern) is a dict with a C(name) key and C(regex_strings) list of strings to match

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

attribute :filters

#name ⇒ String

Returns Name of the Web Application Firewall condition to manage.

Returns:

• (String) —

  Name of the Web Application Firewall condition to manage

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

attribute :name

#purge_filters ⇒ Object^?

Returns Whether to remove existing filters from a condition if not passed in I(filters). Defaults to false.

Returns:

• (Object, nil) —

  Whether to remove existing filters from a condition if not passed in I(filters). Defaults to false

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

attribute :purge_filters

#state ⇒ :present, ...

Returns Whether the condition should be C(present) or C(absent).

Returns:

• (:present, :absent, nil) —

  Whether the condition should be C(present) or C(absent)

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

attribute :state

#type ⇒ :byte, ...

Returns the type of matching to perform.

Returns:

• (:byte, :geo, :ip, :regex, :size, :sql, :xss, nil) —

  the type of matching to perform

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

attribute :type