CustomProtectionRuleSummary¶

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

Bases: object

An overview of a custom protection rule.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary.
`compartment_id`	Gets the compartment_id of this CustomProtectionRuleSummary.
`defined_tags`	Gets the defined_tags of this CustomProtectionRuleSummary.
`display_name`	Gets the display_name of this CustomProtectionRuleSummary.
`freeform_tags`	Gets the freeform_tags of this CustomProtectionRuleSummary.
`id`	Gets the id of this CustomProtectionRuleSummary.
`lifecycle_state`	Gets the lifecycle_state of this CustomProtectionRuleSummary.
`mod_security_rule_ids`	Gets the mod_security_rule_ids of this CustomProtectionRuleSummary.
`time_created`	Gets the time_created of this CustomProtectionRuleSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRuleSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new CustomProtectionRuleSummary 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 CustomProtectionRuleSummary.
compartment_id (str) – The value to assign to the compartment_id property of this CustomProtectionRuleSummary.
display_name (str) – The value to assign to the display_name property of this CustomProtectionRuleSummary.
mod_security_rule_ids (list[str]) – The value to assign to the mod_security_rule_ids property of this CustomProtectionRuleSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CustomProtectionRuleSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this CustomProtectionRuleSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CustomProtectionRuleSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CustomProtectionRuleSummary.

compartment_id¶

Gets the compartment_id of this CustomProtectionRuleSummary. The OCID of the custom protection rule’s compartment.

Returns:	The compartment_id of this CustomProtectionRuleSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this CustomProtectionRuleSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CustomProtectionRuleSummary.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this CustomProtectionRuleSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this CustomProtectionRuleSummary.
Return type:	dict(str, str)

id¶

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

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

lifecycle_state¶

Gets the lifecycle_state of this CustomProtectionRuleSummary. The current lifecycle state of the custom protection rule.

Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this CustomProtectionRuleSummary.
Return type:	str

mod_security_rule_ids¶

Gets the mod_security_rule_ids of this CustomProtectionRuleSummary. The auto-generated ID for the custom protection rule. These IDs are referenced in logs.

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

time_created¶

Gets the time_created of this CustomProtectionRuleSummary. The date and time the protection rule was created, expressed in RFC 3339 timestamp format.

Returns:	The time_created of this CustomProtectionRuleSummary.
Return type:	datetime