CreateAuditProfileDetails¶

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

Bases: object

The details used to create a new audit profile.

Attributes

`TARGET_TYPE_TARGET_DATABASE`	A constant which can be used with the target_type property of a CreateAuditProfileDetails.
`TARGET_TYPE_TARGET_DATABASE_GROUP`	A constant which can be used with the target_type property of a CreateAuditProfileDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateAuditProfileDetails.
`defined_tags`	Gets the defined_tags of this CreateAuditProfileDetails.
`description`	Gets the description of this CreateAuditProfileDetails.
`display_name`	Gets the display_name of this CreateAuditProfileDetails.
`freeform_tags`	Gets the freeform_tags of this CreateAuditProfileDetails.
`is_override_global_paid_usage`	Gets the is_override_global_paid_usage of this CreateAuditProfileDetails.
`is_paid_usage_enabled`	Gets the is_paid_usage_enabled of this CreateAuditProfileDetails.
`offline_months`	Gets the offline_months of this CreateAuditProfileDetails.
`online_months`	Gets the online_months of this CreateAuditProfileDetails.
`target_id`	[Required] Gets the target_id of this CreateAuditProfileDetails.
`target_type`	[Required] Gets the target_type of this CreateAuditProfileDetails.

Methods

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

TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'¶: A constant which can be used with the target_type property of a CreateAuditProfileDetails. 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 CreateAuditProfileDetails. This constant has a value of “TARGET_DATABASE_GROUP”

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateAuditProfileDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateAuditProfileDetails.
target_id (str) – The value to assign to the target_id property of this CreateAuditProfileDetails.
description (str) – The value to assign to the description property of this CreateAuditProfileDetails.
target_type (str) – The value to assign to the target_type property of this CreateAuditProfileDetails. Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”
is_paid_usage_enabled (bool) – The value to assign to the is_paid_usage_enabled property of this CreateAuditProfileDetails.
online_months (int) – The value to assign to the online_months property of this CreateAuditProfileDetails.
offline_months (int) – The value to assign to the offline_months property of this CreateAuditProfileDetails.
is_override_global_paid_usage (bool) – The value to assign to the is_override_global_paid_usage property of this CreateAuditProfileDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAuditProfileDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAuditProfileDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateAuditProfileDetails. The OCID of the compartment where you want to create the audit profile.

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

defined_tags¶

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

description¶

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

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

display_name¶

Gets the display_name of this CreateAuditProfileDetails. The display name of the audit profile. The name does not have to be unique, and it’s updatable.

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

freeform_tags¶

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

is_override_global_paid_usage¶

Gets the is_override_global_paid_usage of this CreateAuditProfileDetails. Indicates whether audit paid usage settings specified at the target database level override both the global and the target database 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 CreateAuditProfileDetails.
Return type:	bool

is_paid_usage_enabled¶

Gets the is_paid_usage_enabled of this CreateAuditProfileDetails. 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 CreateAuditProfileDetails.
Return type:	bool

offline_months¶

Gets the offline_months of this CreateAuditProfileDetails. 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 CreateAuditProfileDetails.
Return type:	int

online_months¶

Gets the online_months of this CreateAuditProfileDetails. 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 CreateAuditProfileDetails.
Return type:	int

target_id¶

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

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

target_type¶

[Required] Gets the target_type of this CreateAuditProfileDetails. The resource type that is represented by the audit profile.

Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”

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