WaasPolicyCustomProtectionRuleSummary¶

class oci.waas.models.WaasPolicyCustomProtectionRuleSummary(**kwargs)¶

Bases: object

The OCID and action of a custom protection rule.

Attributes

`ACTION_BLOCK`	A constant which can be used with the action property of a WaasPolicyCustomProtectionRuleSummary.
`ACTION_DETECT`	A constant which can be used with the action property of a WaasPolicyCustomProtectionRuleSummary.
`action`	Gets the action of this WaasPolicyCustomProtectionRuleSummary.
`display_name`	Gets the display_name of this WaasPolicyCustomProtectionRuleSummary.
`exclusions`	Gets the exclusions of this WaasPolicyCustomProtectionRuleSummary.
`id`	Gets the id of this WaasPolicyCustomProtectionRuleSummary.
`mod_security_rule_ids`	Gets the mod_security_rule_ids of this WaasPolicyCustomProtectionRuleSummary.

Methods

__init__(**kwargs) Initializes a new WaasPolicyCustomProtectionRuleSummary object with values from keyword arguments.

ACTION_BLOCK = 'BLOCK'¶: A constant which can be used with the action property of a WaasPolicyCustomProtectionRuleSummary. This constant has a value of “BLOCK”

ACTION_DETECT = 'DETECT'¶: A constant which can be used with the action property of a WaasPolicyCustomProtectionRuleSummary. This constant has a value of “DETECT”

__init__(**kwargs)¶

Initializes a new WaasPolicyCustomProtectionRuleSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this WaasPolicyCustomProtectionRuleSummary.
display_name (str) – The value to assign to the display_name property of this WaasPolicyCustomProtectionRuleSummary.
action (str) – The value to assign to the action property of this WaasPolicyCustomProtectionRuleSummary. Allowed values for this property are: “DETECT”, “BLOCK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
mod_security_rule_ids (list[str]) – The value to assign to the mod_security_rule_ids property of this WaasPolicyCustomProtectionRuleSummary.
exclusions (list[oci.waas.models.ProtectionRuleExclusion]) – The value to assign to the exclusions property of this WaasPolicyCustomProtectionRuleSummary.

action¶

Gets the action of this WaasPolicyCustomProtectionRuleSummary. The action to take when the custom protection rule is triggered. DETECT - Logs the request when the criteria of the custom protection rule are met. BLOCK - Blocks the request when the criteria of the custom protection rule are met.

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

Returns:	The action of this WaasPolicyCustomProtectionRuleSummary.
Return type:	str

display_name¶

Gets the display_name of this WaasPolicyCustomProtectionRuleSummary. The user-friendly name of the custom protection rule.

Returns:	The display_name of this WaasPolicyCustomProtectionRuleSummary.
Return type:	str

exclusions¶

Gets the exclusions of this WaasPolicyCustomProtectionRuleSummary.

Returns:	The exclusions of this WaasPolicyCustomProtectionRuleSummary.
Return type:	list[oci.waas.models.ProtectionRuleExclusion]

id¶

Gets the id of this WaasPolicyCustomProtectionRuleSummary. The OCID of the custom protection rule.

Returns:	The id of this WaasPolicyCustomProtectionRuleSummary.
Return type:	str

mod_security_rule_ids¶

Gets the mod_security_rule_ids of this WaasPolicyCustomProtectionRuleSummary. The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity’s open source WAF rules, see Mod Security’s documentation.

Returns:	The mod_security_rule_ids of this WaasPolicyCustomProtectionRuleSummary.
Return type:	list[str]