CreateAlertPolicyDetails

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

Bases: object

The details used to create a new alert policy.

Attributes:

ALERT_POLICY_TYPE_AUDITING

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

ALERT_POLICY_TYPE_SECURITY_ASSESSMENT

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

ALERT_POLICY_TYPE_USER_ASSESSMENT

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

SEVERITY_CRITICAL

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

SEVERITY_EVALUATE

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

SEVERITY_HIGH

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

SEVERITY_LOW

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

SEVERITY_MEDIUM

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

alert_policy_rule_details

Gets the alert_policy_rule_details of this CreateAlertPolicyDetails.

alert_policy_type

[Required] Gets the alert_policy_type of this CreateAlertPolicyDetails.

compartment_id

[Required] Gets the compartment_id of this CreateAlertPolicyDetails.

defined_tags

Gets the defined_tags of this CreateAlertPolicyDetails.

description

Gets the description of this CreateAlertPolicyDetails.

display_name

Gets the display_name of this CreateAlertPolicyDetails.

freeform_tags

Gets the freeform_tags of this CreateAlertPolicyDetails.

severity

[Required] Gets the severity of this CreateAlertPolicyDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateAlertPolicyDetails 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 CreateAlertPolicyDetails. 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 CreateAlertPolicyDetails. 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 CreateAlertPolicyDetails. This constant has a value of “USER_ASSESSMENT”

SEVERITY_CRITICAL = 'CRITICAL'

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

SEVERITY_EVALUATE = 'EVALUATE'

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

SEVERITY_HIGH = 'HIGH'

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

SEVERITY_LOW = 'LOW'

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

SEVERITY_MEDIUM = 'MEDIUM'

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

__init__(**kwargs)

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

Parameters
  • alert_policy_type (str) – The value to assign to the alert_policy_type property of this CreateAlertPolicyDetails. Allowed values for this property are: “AUDITING”, “SECURITY_ASSESSMENT”, “USER_ASSESSMENT”

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

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

  • severity (str) – The value to assign to the severity property of this CreateAlertPolicyDetails. Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”

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

  • alert_policy_rule_details (list[oci.data_safe.models.CreateAlertPolicyRuleDetails]) – The value to assign to the alert_policy_rule_details property of this CreateAlertPolicyDetails.

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

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

property alert_policy_rule_details

Gets the alert_policy_rule_details of this CreateAlertPolicyDetails. The details of the alert policy rule.

Returns

The alert_policy_rule_details of this CreateAlertPolicyDetails.

Return type

list[oci.data_safe.models.CreateAlertPolicyRuleDetails]

property alert_policy_type

[Required] Gets the alert_policy_type of this CreateAlertPolicyDetails. Indicates the Data Safe feature the alert policy belongs to

Allowed values for this property are: “AUDITING”, “SECURITY_ASSESSMENT”, “USER_ASSESSMENT”

Returns

The alert_policy_type of this CreateAlertPolicyDetails.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this CreateAlertPolicyDetails. The OCID of the compartment where you want to create the alert policy.

Returns

The compartment_id of this CreateAlertPolicyDetails.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this CreateAlertPolicyDetails.

Return type

str

property display_name

Gets the display_name of this CreateAlertPolicyDetails. The display name of the alert policy. The name does not have to be unique, and it’s changeable.

Returns

The display_name of this CreateAlertPolicyDetails.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property severity

[Required] Gets the severity of this CreateAlertPolicyDetails. Severity level of the alert raised by this policy.

Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”

Returns

The severity of this CreateAlertPolicyDetails.

Return type

str