RequestRateLimitingRule¶

class oci.waf.models.RequestRateLimitingRule(**kwargs)¶

Bases: oci.waf.models.web_app_firewall_policy_rule.WebAppFirewallPolicyRule

Rule that represents RequestRateLimitingConfigurations. Only actions of the following types are allowed to be referenced in this rule: * CHECK * RETURN_HTTP_RESPONSE

Attributes

`CONDITION_LANGUAGE_JMESPATH`	str(object=’’) -> str
`TYPE_ACCESS_CONTROL`	str(object=’’) -> str
`TYPE_PROTECTION`	str(object=’’) -> str
`TYPE_REQUEST_RATE_LIMITING`	str(object=’’) -> str
`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.
`configurations`	[Required] Gets the configurations of this RequestRateLimitingRule.
`name`	[Required] Gets the name of this WebAppFirewallPolicyRule.
`type`	[Required] Gets the type of this WebAppFirewallPolicyRule.

Methods

`__init__`(**kwargs)	Initializes a new RequestRateLimitingRule 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'¶

TYPE_ACCESS_CONTROL = 'ACCESS_CONTROL'¶

TYPE_PROTECTION = 'PROTECTION'¶

TYPE_REQUEST_RATE_LIMITING = 'REQUEST_RATE_LIMITING'¶

__init__(**kwargs)¶

Initializes a new RequestRateLimitingRule object with values from keyword arguments. The default value of the type attribute of this class is REQUEST_RATE_LIMITING and it should not be changed. 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 RequestRateLimitingRule. 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 RequestRateLimitingRule.
condition_language (str) – The value to assign to the condition_language property of this RequestRateLimitingRule. 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 RequestRateLimitingRule.
action_name (str) – The value to assign to the action_name property of this RequestRateLimitingRule.
configurations (list[oci.waf.models.RequestRateLimitingConfiguration]) – The value to assign to the configurations property of this RequestRateLimitingRule.

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

configurations¶

[Required] Gets the configurations of this RequestRateLimitingRule. Rate Limiting Configurations. Each configuration counts requests towards its own requestsLimit.

Returns:	The configurations of this RequestRateLimitingRule.
Return type:	list[oci.waf.models.RequestRateLimitingConfiguration]

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