WebAppFirewallPolicyRule

class oci.waf.models.WebAppFirewallPolicyRule(**kwargs)

Bases: object

Base schema for WebAppFirewallPolicyRules, including properties common to all of them.

Attributes

CONDITION_LANGUAGE_JMESPATH	A constant which can be used with the condition_language property of a WebAppFirewallPolicyRule.
TYPE_ACCESS_CONTROL	A constant which can be used with the type property of a WebAppFirewallPolicyRule.
TYPE_PROTECTION	A constant which can be used with the type property of a WebAppFirewallPolicyRule.
TYPE_REQUEST_RATE_LIMITING	A constant which can be used with the type property of a WebAppFirewallPolicyRule.
action_name	[Required] Gets the action_name of this WebAppFirewallPolicyRule.
condition	Gets the condition of this WebAppFirewallPolicyRule.
condition_language	Gets the condition_language of this WebAppFirewallPolicyRule.
name	[Required] Gets the name of this WebAppFirewallPolicyRule.
type	[Required] Gets the type of this WebAppFirewallPolicyRule.

Methods

__init__(**kwargs)	Initializes a new WebAppFirewallPolicyRule object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONDITION_LANGUAGE_JMESPATH = 'JMESPATH'

A constant which can be used with the condition_language property of a WebAppFirewallPolicyRule. This constant has a value of “JMESPATH”

TYPE_ACCESS_CONTROL = 'ACCESS_CONTROL'

A constant which can be used with the type property of a WebAppFirewallPolicyRule. This constant has a value of “ACCESS_CONTROL”

TYPE_PROTECTION = 'PROTECTION'

A constant which can be used with the type property of a WebAppFirewallPolicyRule. This constant has a value of “PROTECTION”

TYPE_REQUEST_RATE_LIMITING = 'REQUEST_RATE_LIMITING'

A constant which can be used with the type property of a WebAppFirewallPolicyRule. This constant has a value of “REQUEST_RATE_LIMITING”

__init__(**kwargs)

Initializes a new WebAppFirewallPolicyRule object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• ProtectionRule
• RequestRateLimitingRule
• AccessControlRule

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

• type (str) – The value to assign to the type property of this WebAppFirewallPolicyRule. Allowed values for this property are: “ACCESS_CONTROL”, “PROTECTION”, “REQUEST_RATE_LIMITING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
• name (str) – The value to assign to the name property of this WebAppFirewallPolicyRule.
• condition_language (str) – The value to assign to the condition_language property of this WebAppFirewallPolicyRule. Allowed values for this property are: “JMESPATH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
• condition (str) – The value to assign to the condition property of this WebAppFirewallPolicyRule.
• action_name (str) – The value to assign to the action_name property of this WebAppFirewallPolicyRule.

action_name

[Required] Gets the action_name of this WebAppFirewallPolicyRule. References action by name from actions defined in WebAppFirewallPolicy.

Returns:The action_name of this WebAppFirewallPolicyRule. Return type:str

condition

Gets the condition of this WebAppFirewallPolicyRule. An expression that determines whether or not the rule action should be executed.

Returns:The condition of this WebAppFirewallPolicyRule. Return type:str

condition_language

Gets the condition_language of this WebAppFirewallPolicyRule. The language used to parse condition from field condition. Available languages:

• JMESPATH an extended JMESPath language syntax.

Allowed values for this property are: “JMESPATH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The condition_language of this WebAppFirewallPolicyRule. Return type:str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

name

[Required] Gets the name of this WebAppFirewallPolicyRule. Rule name. Must be unique within the module.

Returns:The name of this WebAppFirewallPolicyRule. Return type:str

type

[Required] Gets the type of this WebAppFirewallPolicyRule. Type of WebAppFirewallPolicyRule.

Allowed values for this property are: “ACCESS_CONTROL”, “PROTECTION”, “REQUEST_RATE_LIMITING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The type of this WebAppFirewallPolicyRule. Return type:str