AuditProfile

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

Bases: object

The resource represents audit profile settings and audit configurations for the database target, and helps evaluate the initial audit data volume for configuring collection in Data Safe. The resource is also responsible for auto-discovery of audit trails in the database target during target’s registration.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_NEEDS_ATTENTION

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

LIFECYCLE_STATE_UPDATING

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

TARGET_TYPE_TARGET_DATABASE

A constant which can be used with the target_type property of a AuditProfile.

TARGET_TYPE_TARGET_DATABASE_GROUP

A constant which can be used with the target_type property of a AuditProfile.

audit_collected_volume

Gets the audit_collected_volume of this AuditProfile.

audit_trails

Gets the audit_trails of this AuditProfile.

compartment_id

[Required] Gets the compartment_id of this AuditProfile.

defined_tags

Gets the defined_tags of this AuditProfile.

description

Gets the description of this AuditProfile.

display_name

[Required] Gets the display_name of this AuditProfile.

freeform_tags

Gets the freeform_tags of this AuditProfile.

id

[Required] Gets the id of this AuditProfile.

is_override_global_paid_usage

Gets the is_override_global_paid_usage of this AuditProfile.

is_override_global_retention_setting

[Required] Gets the is_override_global_retention_setting of this AuditProfile.

is_paid_usage_enabled

[Required] Gets the is_paid_usage_enabled of this AuditProfile.

lifecycle_details

Gets the lifecycle_details of this AuditProfile.

lifecycle_state

[Required] Gets the lifecycle_state of this AuditProfile.

offline_months

[Required] Gets the offline_months of this AuditProfile.

offline_months_source

Gets the offline_months_source of this AuditProfile.

online_months

[Required] Gets the online_months of this AuditProfile.

online_months_source

Gets the online_months_source of this AuditProfile.

paid_usage_source

Gets the paid_usage_source of this AuditProfile.

system_tags

Gets the system_tags of this AuditProfile.

target_id

[Required] Gets the target_id of this AuditProfile.

target_type

Gets the target_type of this AuditProfile.

time_created

[Required] Gets the time_created of this AuditProfile.

time_updated

[Required] Gets the time_updated of this AuditProfile.

Methods:

__init__(**kwargs)

Initializes a new AuditProfile object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a AuditProfile. 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 AuditProfile. 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 AuditProfile. 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 AuditProfile. 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 AuditProfile. This constant has a value of “TARGET_DATABASE_GROUP”

__init__(**kwargs)

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

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuditProfile. 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’.

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

  • target_id (str) – The value to assign to the target_id property of this AuditProfile.

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

  • audit_trails (list[oci.data_safe.models.AuditTrail]) – The value to assign to the audit_trails property of this AuditProfile.

  • is_paid_usage_enabled (bool) – The value to assign to the is_paid_usage_enabled property of this AuditProfile.

  • online_months (int) – The value to assign to the online_months property of this AuditProfile.

  • offline_months (int) – The value to assign to the offline_months property of this AuditProfile.

  • audit_collected_volume (int) – The value to assign to the audit_collected_volume property of this AuditProfile.

  • is_override_global_retention_setting (bool) – The value to assign to the is_override_global_retention_setting property of this AuditProfile.

  • is_override_global_paid_usage (bool) – The value to assign to the is_override_global_paid_usage property of this AuditProfile.

  • online_months_source (str) – The value to assign to the online_months_source property of this AuditProfile.

  • offline_months_source (str) – The value to assign to the offline_months_source property of this AuditProfile.

  • paid_usage_source (str) – The value to assign to the paid_usage_source property of this AuditProfile.

  • target_type (str) – The value to assign to the target_type property of this AuditProfile. 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 AuditProfile.

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

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

property audit_collected_volume

Gets the audit_collected_volume of this AuditProfile. 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 AuditProfile.

Return type

int

property audit_trails

Gets the audit_trails of this AuditProfile. Contains the list of available audit trails on the target database.

Returns

The audit_trails of this AuditProfile.

Return type

list[oci.data_safe.models.AuditTrail]

property compartment_id

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

Returns

The compartment_id of this AuditProfile.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this AuditProfile.

Return type

str

property display_name

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

Returns

The display_name of this AuditProfile.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this AuditProfile.

Return type

str

property is_override_global_paid_usage

Gets the is_override_global_paid_usage of this AuditProfile. 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 AuditProfile.

Return type

bool

property is_override_global_retention_setting

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

Returns

The is_override_global_retention_setting of this AuditProfile.

Return type

bool

property is_paid_usage_enabled

[Required] Gets the is_paid_usage_enabled of this AuditProfile. 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 AuditProfile.

Return type

bool

property lifecycle_details

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

Returns

The lifecycle_details of this AuditProfile.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this AuditProfile. 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 AuditProfile.

Return type

str

property offline_months

[Required] Gets the offline_months of this AuditProfile. 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 AuditProfile.

Return type

int

property offline_months_source

Gets the offline_months_source of this AuditProfile. The name or the OCID of the resource from which the offline month retention setting is sourced. For example, a global setting or a target database group OCID.

Returns

The offline_months_source of this AuditProfile.

Return type

str

property online_months

[Required] Gets the online_months of this AuditProfile. 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 AuditProfile.

Return type

int

property online_months_source

Gets the online_months_source of this AuditProfile. The name or the OCID of the resource from which the online month retention setting is sourced. For example, a global setting or a target database group OCID.

Returns

The online_months_source of this AuditProfile.

Return type

str

property paid_usage_source

Gets the paid_usage_source of this AuditProfile. The name or the OCID of the resource from which the paid usage setting is sourced. For example, a global setting or a target database group OCID.

Returns

The paid_usage_source of this AuditProfile.

Return type

str

property system_tags

Gets the system_tags of this AuditProfile. 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 AuditProfile.

Return type

dict(str, dict(str, object))

property target_id

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

Returns

The target_id of this AuditProfile.

Return type

str

property target_type

Gets the target_type of this AuditProfile. 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 AuditProfile.

Return type

str

property time_created

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

Returns

The time_created of this AuditProfile.

Return type

datetime

property time_updated

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

Returns

The time_updated of this AuditProfile.

Return type

datetime