AlertPolicy

class oci.data_safe.models.AlertPolicy(**kwargs)

Bases: object

An Alert Policy is a set of alerting rules evaluated against a target. The alert policy is said to be satisfied when all rules in the policy evaulate to true. If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.

Attributes:

ALERT_POLICY_TYPE_AUDITING

A constant which can be used with the alert_policy_type property of a AlertPolicy.

ALERT_POLICY_TYPE_SECURITY_ASSESSMENT

A constant which can be used with the alert_policy_type property of a AlertPolicy.

ALERT_POLICY_TYPE_USER_ASSESSMENT

A constant which can be used with the alert_policy_type property of a AlertPolicy.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a AlertPolicy.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a AlertPolicy.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a AlertPolicy.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a AlertPolicy.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a AlertPolicy.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a AlertPolicy.

SEVERITY_CRITICAL

A constant which can be used with the severity property of a AlertPolicy.

SEVERITY_EVALUATE

A constant which can be used with the severity property of a AlertPolicy.

SEVERITY_HIGH

A constant which can be used with the severity property of a AlertPolicy.

SEVERITY_LOW

A constant which can be used with the severity property of a AlertPolicy.

SEVERITY_MEDIUM

A constant which can be used with the severity property of a AlertPolicy.

alert_policy_type

Gets the alert_policy_type of this AlertPolicy.

compartment_id

[Required] Gets the compartment_id of this AlertPolicy.

defined_tags

Gets the defined_tags of this AlertPolicy.

description

Gets the description of this AlertPolicy.

display_name

[Required] Gets the display_name of this AlertPolicy.

freeform_tags

Gets the freeform_tags of this AlertPolicy.

id

[Required] Gets the id of this AlertPolicy.

is_user_defined

Gets the is_user_defined of this AlertPolicy.

lifecycle_details

Gets the lifecycle_details of this AlertPolicy.

lifecycle_state

[Required] Gets the lifecycle_state of this AlertPolicy.

severity

Gets the severity of this AlertPolicy.

system_tags

Gets the system_tags of this AlertPolicy.

time_created

[Required] Gets the time_created of this AlertPolicy.

time_updated

[Required] Gets the time_updated of this AlertPolicy.

Methods:

__init__(**kwargs)

Initializes a new AlertPolicy object with values from keyword arguments.

ALERT_POLICY_TYPE_AUDITING = 'AUDITING'

A constant which can be used with the alert_policy_type property of a AlertPolicy. This constant has a value of “AUDITING”

ALERT_POLICY_TYPE_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'

A constant which can be used with the alert_policy_type property of a AlertPolicy. This constant has a value of “SECURITY_ASSESSMENT”

ALERT_POLICY_TYPE_USER_ASSESSMENT = 'USER_ASSESSMENT'

A constant which can be used with the alert_policy_type property of a AlertPolicy. This constant has a value of “USER_ASSESSMENT”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a AlertPolicy. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a AlertPolicy. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a AlertPolicy. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a AlertPolicy. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a AlertPolicy. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a AlertPolicy. This constant has a value of “UPDATING”

SEVERITY_CRITICAL = 'CRITICAL'

A constant which can be used with the severity property of a AlertPolicy. This constant has a value of “CRITICAL”

SEVERITY_EVALUATE = 'EVALUATE'

A constant which can be used with the severity property of a AlertPolicy. This constant has a value of “EVALUATE”

SEVERITY_HIGH = 'HIGH'

A constant which can be used with the severity property of a AlertPolicy. This constant has a value of “HIGH”

SEVERITY_LOW = 'LOW'

A constant which can be used with the severity property of a AlertPolicy. This constant has a value of “LOW”

SEVERITY_MEDIUM = 'MEDIUM'

A constant which can be used with the severity property of a AlertPolicy. This constant has a value of “MEDIUM”

__init__(**kwargs)

Initializes a new AlertPolicy 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 AlertPolicy.

  • display_name (str) – The value to assign to the display_name property of this AlertPolicy.

  • description (str) – The value to assign to the description property of this AlertPolicy.

  • alert_policy_type (str) – The value to assign to the alert_policy_type property of this AlertPolicy. Allowed values for this property are: “AUDITING”, “SECURITY_ASSESSMENT”, “USER_ASSESSMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • is_user_defined (bool) – The value to assign to the is_user_defined property of this AlertPolicy.

  • severity (str) – The value to assign to the severity property of this AlertPolicy. Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • compartment_id (str) – The value to assign to the compartment_id property of this AlertPolicy.

  • time_created (datetime) – The value to assign to the time_created property of this AlertPolicy.

  • time_updated (datetime) – The value to assign to the time_updated property of this AlertPolicy.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlertPolicy. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this AlertPolicy.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlertPolicy.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlertPolicy.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AlertPolicy.

property alert_policy_type

Gets the alert_policy_type of this AlertPolicy. Indicates the Data Safe feature to which the alert policy belongs.

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

Returns

The alert_policy_type of this AlertPolicy.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this AlertPolicy. The OCID of the compartment that contains the alert policy.

Returns

The compartment_id of this AlertPolicy.

Return type

str

property defined_tags

Gets the defined_tags of this AlertPolicy. 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 AlertPolicy.

Return type

dict(str, dict(str, object))

property description

Gets the description of this AlertPolicy. The description of the alert policy.

Returns

The description of this AlertPolicy.

Return type

str

property display_name

[Required] Gets the display_name of this AlertPolicy. The display name of the alert policy.

Returns

The display_name of this AlertPolicy.

Return type

str

property freeform_tags

Gets the freeform_tags of this AlertPolicy. 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 AlertPolicy.

Return type

dict(str, str)

property id

[Required] Gets the id of this AlertPolicy. The OCID of the alert policy.

Returns

The id of this AlertPolicy.

Return type

str

property is_user_defined

Gets the is_user_defined of this AlertPolicy. Indicates if the alert policy is user-defined (true) or pre-defined (false).

Returns

The is_user_defined of this AlertPolicy.

Return type

bool

property lifecycle_details

Gets the lifecycle_details of this AlertPolicy. Details about the current state of the alert policy.

Returns

The lifecycle_details of this AlertPolicy.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this AlertPolicy. The current state of the alert.

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

Returns

The lifecycle_state of this AlertPolicy.

Return type

str

property severity

Gets the severity of this AlertPolicy. Severity level of the alert raised by this policy.

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

Returns

The severity of this AlertPolicy.

Return type

str

property system_tags

Gets the system_tags of this AlertPolicy. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this AlertPolicy.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this AlertPolicy. Creation date and time of the alert policy, in the format defined by RFC3339.

Returns

The time_created of this AlertPolicy.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this AlertPolicy. Last date and time the alert policy was updated, in the format defined by RFC3339.

Returns

The time_updated of this AlertPolicy.

Return type

datetime