AuditPolicy¶
- class oci.data_safe.models.AuditPolicy(**kwargs)¶
Bases:
objectThe resource represents all available audit policies relevant for the target database with their corresponding audit conditions. The audit policies could be in any one of the following 3 states in the target database 1) Created and enabled 2) Created but not enabled 3) Not created For more details on available audit policies, refer to documentation.
Attributes:
A constant which can be used with the lifecycle_state property of a AuditPolicy.
A constant which can be used with the lifecycle_state property of a AuditPolicy.
A constant which can be used with the lifecycle_state property of a AuditPolicy.
A constant which can be used with the lifecycle_state property of a AuditPolicy.
A constant which can be used with the lifecycle_state property of a AuditPolicy.
A constant which can be used with the lifecycle_state property of a AuditPolicy.
A constant which can be used with the lifecycle_state property of a AuditPolicy.
Gets the audit_conditions of this AuditPolicy.
Gets the audit_specifications of this AuditPolicy.
[Required] Gets the compartment_id of this AuditPolicy.
Gets the defined_tags of this AuditPolicy.
Gets the description of this AuditPolicy.
[Required] Gets the display_name of this AuditPolicy.
Gets the freeform_tags of this AuditPolicy.
[Required] Gets the id of this AuditPolicy.
[Required] Gets the is_data_safe_service_account_excluded of this AuditPolicy.
Gets the lifecycle_details of this AuditPolicy.
[Required] Gets the lifecycle_state of this AuditPolicy.
Gets the system_tags of this AuditPolicy.
[Required] Gets the target_id of this AuditPolicy.
[Required] Gets the time_created of this AuditPolicy.
Gets the time_last_provisioned of this AuditPolicy.
Gets the time_last_retrieved of this AuditPolicy.
Gets the time_updated of this AuditPolicy.
Methods:
__init__(**kwargs)Initializes a new AuditPolicy object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “FAILED”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a AuditPolicy. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new AuditPolicy 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 AuditPolicy.
compartment_id (str) – The value to assign to the compartment_id property of this AuditPolicy.
display_name (str) – The value to assign to the display_name property of this AuditPolicy.
description (str) – The value to assign to the description property of this AuditPolicy.
time_created (datetime) – The value to assign to the time_created property of this AuditPolicy.
time_updated (datetime) – The value to assign to the time_updated property of this AuditPolicy.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuditPolicy. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, ‘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 AuditPolicy.
target_id (str) – The value to assign to the target_id property of this AuditPolicy.
is_data_safe_service_account_excluded (bool) – The value to assign to the is_data_safe_service_account_excluded property of this AuditPolicy.
time_last_provisioned (datetime) – The value to assign to the time_last_provisioned property of this AuditPolicy.
time_last_retrieved (datetime) – The value to assign to the time_last_retrieved property of this AuditPolicy.
audit_specifications (list[oci.data_safe.models.AuditSpecification]) – The value to assign to the audit_specifications property of this AuditPolicy.
audit_conditions (list[oci.data_safe.models.AuditConditions]) – The value to assign to the audit_conditions property of this AuditPolicy.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AuditPolicy.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AuditPolicy.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AuditPolicy.
- property audit_conditions¶
Gets the audit_conditions of this AuditPolicy. Lists the audit policy provisioning conditions for the target database.
- Returns
The audit_conditions of this AuditPolicy.
- Return type
- property audit_specifications¶
Gets the audit_specifications of this AuditPolicy. Represents all available audit policy specifications relevant for the target database. For more details on available audit polcies, refer to documentation.
- Returns
The audit_specifications of this AuditPolicy.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this AuditPolicy. The OCID of the compartment containing the audit policy.
- Returns
The compartment_id of this AuditPolicy.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this AuditPolicy. 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 AuditPolicy.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this AuditPolicy. Description of the audit policy.
- Returns
The description of this AuditPolicy.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this AuditPolicy. The display name of the audit policy.
- Returns
The display_name of this AuditPolicy.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this AuditPolicy. 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 AuditPolicy.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this AuditPolicy. The OCID of the audit policy.
- Returns
The id of this AuditPolicy.
- Return type
str
- property is_data_safe_service_account_excluded¶
[Required] Gets the is_data_safe_service_account_excluded of this AuditPolicy. Option provided to users at the target to indicate whether the Data Safe service account has to be excluded while provisioning the audit policies.
- Returns
The is_data_safe_service_account_excluded of this AuditPolicy.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this AuditPolicy. Details about the current state of the audit policy in Data Safe.
- Returns
The lifecycle_details of this AuditPolicy.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AuditPolicy. The current state of the audit policy.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “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 AuditPolicy.
- Return type
str
- property system_tags¶
Gets the system_tags of this AuditPolicy. 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 AuditPolicy.
- Return type
dict(str, dict(str, object))
- property target_id¶
[Required] Gets the target_id of this AuditPolicy. The OCID of the target for which the audit policy is created.
- Returns
The target_id of this AuditPolicy.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this AuditPolicy. The time the the audit policy was created, in the format defined by RFC3339.
- Returns
The time_created of this AuditPolicy.
- Return type
datetime
- property time_last_provisioned¶
Gets the time_last_provisioned of this AuditPolicy. Indicates the last provisioning time of audit policies on the target, in the format defined by RFC3339.
- Returns
The time_last_provisioned of this AuditPolicy.
- Return type
datetime
- property time_last_retrieved¶
Gets the time_last_retrieved of this AuditPolicy. The time when the audit policies was last retrieved from this target, in the format defined by RFC3339.
- Returns
The time_last_retrieved of this AuditPolicy.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this AuditPolicy. The last date and time the audit policy was updated, in the format defined by RFC3339.
- Returns
The time_updated of this AuditPolicy.
- Return type
datetime