AuditProfileSummary¶

class oci.data_safe.models.AuditProfileSummary(**kwargs)¶

Bases: object

Summary of an audit profile.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a AuditProfileSummary.
`TARGET_TYPE_TARGET_DATABASE`	A constant which can be used with the target_type property of a AuditProfileSummary.
`TARGET_TYPE_TARGET_DATABASE_GROUP`	A constant which can be used with the target_type property of a AuditProfileSummary.
`audit_collected_volume`	Gets the audit_collected_volume of this AuditProfileSummary.
`compartment_id`	[Required] Gets the compartment_id of this AuditProfileSummary.
`defined_tags`	Gets the defined_tags of this AuditProfileSummary.
`description`	Gets the description of this AuditProfileSummary.
`display_name`	[Required] Gets the display_name of this AuditProfileSummary.
`freeform_tags`	Gets the freeform_tags of this AuditProfileSummary.
`id`	[Required] Gets the id of this AuditProfileSummary.
`is_override_global_paid_usage`	Gets the is_override_global_paid_usage of this AuditProfileSummary.
`is_override_global_retention_setting`	[Required] Gets the is_override_global_retention_setting of this AuditProfileSummary.
`is_paid_usage_enabled`	[Required] Gets the is_paid_usage_enabled of this AuditProfileSummary.
`lifecycle_details`	Gets the lifecycle_details of this AuditProfileSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AuditProfileSummary.
`offline_months`	[Required] Gets the offline_months of this AuditProfileSummary.
`online_months`	[Required] Gets the online_months of this AuditProfileSummary.
`target_id`	[Required] Gets the target_id of this AuditProfileSummary.
`target_type`	Gets the target_type of this AuditProfileSummary.
`time_created`	[Required] Gets the time_created of this AuditProfileSummary.
`time_updated`	[Required] Gets the time_updated of this AuditProfileSummary.

Methods

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

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a AuditProfileSummary. 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 AuditProfileSummary. 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 AuditProfileSummary. This constant has a value of “UPDATING”

TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'¶: A constant which can be used with the target_type property of a AuditProfileSummary. This constant has a value of “TARGET_DATABASE”

TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'¶: A constant which can be used with the target_type property of a AuditProfileSummary. This constant has a value of “TARGET_DATABASE_GROUP”

__init__(**kwargs)¶

Initializes a new AuditProfileSummary 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 AuditProfileSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AuditProfileSummary.
display_name (str) – The value to assign to the display_name property of this AuditProfileSummary.
time_created (datetime) – The value to assign to the time_created property of this AuditProfileSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AuditProfileSummary.
target_id (str) – The value to assign to the target_id property of this AuditProfileSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuditProfileSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “FAILED”, “NEEDS_ATTENTION”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this AuditProfileSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this AuditProfileSummary.
is_paid_usage_enabled (bool) – The value to assign to the is_paid_usage_enabled property of this AuditProfileSummary.
online_months (int) – The value to assign to the online_months property of this AuditProfileSummary.
offline_months (int) – The value to assign to the offline_months property of this AuditProfileSummary.
audit_collected_volume (int) – The value to assign to the audit_collected_volume property of this AuditProfileSummary.
is_override_global_retention_setting (bool) – The value to assign to the is_override_global_retention_setting property of this AuditProfileSummary.
is_override_global_paid_usage (bool) – The value to assign to the is_override_global_paid_usage property of this AuditProfileSummary.
target_type (str) – The value to assign to the target_type property of this AuditProfileSummary. Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AuditProfileSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AuditProfileSummary.

audit_collected_volume¶

Gets the audit_collected_volume of this AuditProfileSummary. Number of audit records collected in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.

Returns:	The audit_collected_volume of this AuditProfileSummary.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this AuditProfileSummary. The OCID of the compartment that contains the audit profile.

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

defined_tags¶

Gets the defined_tags of this AuditProfileSummary. 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 AuditProfileSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this AuditProfileSummary. The description of the audit profile.

Returns:	The description of this AuditProfileSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this AuditProfileSummary. The display name of the audit profile.

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

freeform_tags¶

Gets the freeform_tags of this AuditProfileSummary. 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 AuditProfileSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this AuditProfileSummary. The OCID of the audit profile.

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

is_override_global_paid_usage¶

Gets the is_override_global_paid_usage of this AuditProfileSummary. Indicates whether audit paid usage settings specified at the target database level override both the global settings and the target group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see Data Safe Price List.

Returns:	The is_override_global_paid_usage of this AuditProfileSummary.
Return type:	bool

is_override_global_retention_setting¶

[Required] Gets the is_override_global_retention_setting of this AuditProfileSummary. Indicates whether audit retention settings like online and offline months set at the target level override the global or target database group level audit retention settings.

Returns:	The is_override_global_retention_setting of this AuditProfileSummary.
Return type:	bool

is_paid_usage_enabled¶

[Required] Gets the is_paid_usage_enabled of this AuditProfileSummary. Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

Returns:	The is_paid_usage_enabled of this AuditProfileSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this AuditProfileSummary. Details about the current state of the audit profile in Data Safe.

Returns:	The lifecycle_details of this AuditProfileSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this AuditProfileSummary. The current state of the audit profile.

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

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

offline_months¶

[Required] Gets the offline_months of this AuditProfileSummary. Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support.

Returns:	The offline_months of this AuditProfileSummary.
Return type:	int

online_months¶

[Required] Gets the online_months of this AuditProfileSummary. Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months

Returns:	The online_months of this AuditProfileSummary.
Return type:	int

target_id¶

[Required] Gets the target_id of this AuditProfileSummary. The OCID of the target database for which the audit profile is created.

Returns:	The target_id of this AuditProfileSummary.
Return type:	str

target_type¶

Gets the target_type of this AuditProfileSummary. The resource type that is represented by the audit profile.

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

Returns:	The target_type of this AuditProfileSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this AuditProfileSummary. The date and time the audit profile was created, in the format defined by RFC3339.

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

time_updated¶

[Required] Gets the time_updated of this AuditProfileSummary. The date and time the audit profile was updated, in the format defined by RFC3339.

Returns:	The time_updated of this AuditProfileSummary.
Return type:	datetime