/** * Data Safe API * APIs for using Oracle Data Safe. * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * 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. */ export interface AuditProfile { /** * The OCID of the audit profile. */ "id": string; /** * The OCID of the compartment that contains the audit profile. */ "compartmentId": string; /** * The display name of the audit profile. */ "displayName": string; /** * The date and time the audit profile was created, in the format defined by RFC3339. */ "timeCreated": Date; /** * The date and time the audit profile was updated, in the format defined by RFC3339. */ "timeUpdated": Date; /** * The current state of the audit profile. */ "lifecycleState": model.AuditProfileLifecycleState; /** * Details about the current state of the audit profile in Data Safe. */ "lifecycleDetails"?: string; /** * The OCID of the target database or target database group for which the audit profile is created. */ "targetId": string; /** * The description of the audit profile. */ "description"?: string; /** * Contains the list of available audit trails on the target database. */ "auditTrails"?: Array; /** * 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. * */ "isPaidUsageEnabled": boolean; /** * Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. * Minimum: 1; Maximum: 12 months * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "onlineMonths": number; /** * 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. * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "offlineMonths": number; /** * 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. * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "auditCollectedVolume"?: number; /** * 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. * */ "isOverrideGlobalRetentionSetting": boolean; /** * 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](https://www.oracle.com/cloud/price-list/#data-safe). * */ "isOverrideGlobalPaidUsage"?: boolean; /** * 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. */ "onlineMonthsSource"?: string; /** * 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. */ "offlineMonthsSource"?: string; /** * 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. */ "paidUsageSource"?: string; /** * The resource type that is represented by the audit profile. */ "targetType"?: model.AuditProfileTargetType; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) *

Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. * Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}} * */ "systemTags"?: { [key: string]: { [key: string]: any; }; }; } export declare namespace AuditProfile { function getJsonObj(obj: AuditProfile): object; function getDeserializedJsonObj(obj: AuditProfile): object; }