oci.DataSafe.AuditProfile
Explore with Pulumi AI
This resource provides the Audit Profile resource in Oracle Cloud Infrastructure Data Safe service.
Create a new audit profile resource for a target group. For a target database, it will update the auto created audit profile
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAuditProfile = new oci.datasafe.AuditProfile("test_audit_profile", {
compartmentId: compartmentId,
targetId: testTarget.id,
targetType: auditProfileTargetType,
definedTags: {
"Operations.CostCenter": "42",
},
description: auditProfileDescription,
displayName: auditProfileDisplayName,
freeformTags: {
Department: "Finance",
},
isOverrideGlobalPaidUsage: auditProfileIsOverrideGlobalPaidUsage,
isPaidUsageEnabled: auditProfileIsPaidUsageEnabled,
offlineMonths: auditProfileOfflineMonths,
onlineMonths: auditProfileOnlineMonths,
changeRetentionTrigger: retentionTrigger,
isOverrideGlobalRetentionSetting: true,
});
import pulumi
import pulumi_oci as oci
test_audit_profile = oci.datasafe.AuditProfile("test_audit_profile",
compartment_id=compartment_id,
target_id=test_target["id"],
target_type=audit_profile_target_type,
defined_tags={
"Operations.CostCenter": "42",
},
description=audit_profile_description,
display_name=audit_profile_display_name,
freeform_tags={
"Department": "Finance",
},
is_override_global_paid_usage=audit_profile_is_override_global_paid_usage,
is_paid_usage_enabled=audit_profile_is_paid_usage_enabled,
offline_months=audit_profile_offline_months,
online_months=audit_profile_online_months,
change_retention_trigger=retention_trigger,
is_override_global_retention_setting=True)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/datasafe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := datasafe.NewAuditProfile(ctx, "test_audit_profile", &datasafe.AuditProfileArgs{
CompartmentId: pulumi.Any(compartmentId),
TargetId: pulumi.Any(testTarget.Id),
TargetType: pulumi.Any(auditProfileTargetType),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
Description: pulumi.Any(auditProfileDescription),
DisplayName: pulumi.Any(auditProfileDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
IsOverrideGlobalPaidUsage: pulumi.Any(auditProfileIsOverrideGlobalPaidUsage),
IsPaidUsageEnabled: pulumi.Any(auditProfileIsPaidUsageEnabled),
OfflineMonths: pulumi.Any(auditProfileOfflineMonths),
OnlineMonths: pulumi.Any(auditProfileOnlineMonths),
ChangeRetentionTrigger: pulumi.Any(retentionTrigger),
IsOverrideGlobalRetentionSetting: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testAuditProfile = new Oci.DataSafe.AuditProfile("test_audit_profile", new()
{
CompartmentId = compartmentId,
TargetId = testTarget.Id,
TargetType = auditProfileTargetType,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
Description = auditProfileDescription,
DisplayName = auditProfileDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
IsOverrideGlobalPaidUsage = auditProfileIsOverrideGlobalPaidUsage,
IsPaidUsageEnabled = auditProfileIsPaidUsageEnabled,
OfflineMonths = auditProfileOfflineMonths,
OnlineMonths = auditProfileOnlineMonths,
ChangeRetentionTrigger = retentionTrigger,
IsOverrideGlobalRetentionSetting = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.AuditProfile;
import com.pulumi.oci.DataSafe.AuditProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testAuditProfile = new AuditProfile("testAuditProfile", AuditProfileArgs.builder()
.compartmentId(compartmentId)
.targetId(testTarget.id())
.targetType(auditProfileTargetType)
.definedTags(Map.of("Operations.CostCenter", "42"))
.description(auditProfileDescription)
.displayName(auditProfileDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.isOverrideGlobalPaidUsage(auditProfileIsOverrideGlobalPaidUsage)
.isPaidUsageEnabled(auditProfileIsPaidUsageEnabled)
.offlineMonths(auditProfileOfflineMonths)
.onlineMonths(auditProfileOnlineMonths)
.changeRetentionTrigger(retentionTrigger)
.isOverrideGlobalRetentionSetting(true)
.build());
}
}
resources:
testAuditProfile:
type: oci:DataSafe:AuditProfile
name: test_audit_profile
properties:
compartmentId: ${compartmentId}
targetId: ${testTarget.id}
targetType: ${auditProfileTargetType}
definedTags:
Operations.CostCenter: '42'
description: ${auditProfileDescription}
displayName: ${auditProfileDisplayName}
freeformTags:
Department: Finance
isOverrideGlobalPaidUsage: ${auditProfileIsOverrideGlobalPaidUsage}
isPaidUsageEnabled: ${auditProfileIsPaidUsageEnabled}
offlineMonths: ${auditProfileOfflineMonths}
onlineMonths: ${auditProfileOnlineMonths}
changeRetentionTrigger: ${retentionTrigger}
isOverrideGlobalRetentionSetting: true
Create AuditProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AuditProfile(name: string, args: AuditProfileArgs, opts?: CustomResourceOptions);
@overload
def AuditProfile(resource_name: str,
args: AuditProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AuditProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
target_id: Optional[str] = None,
compartment_id: Optional[str] = None,
target_type: Optional[str] = None,
is_override_global_paid_usage: Optional[bool] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
change_retention_trigger: Optional[int] = None,
is_override_global_retention_setting: Optional[bool] = None,
is_paid_usage_enabled: Optional[bool] = None,
offline_months: Optional[int] = None,
online_months: Optional[int] = None,
description: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None)
func NewAuditProfile(ctx *Context, name string, args AuditProfileArgs, opts ...ResourceOption) (*AuditProfile, error)
public AuditProfile(string name, AuditProfileArgs args, CustomResourceOptions? opts = null)
public AuditProfile(String name, AuditProfileArgs args)
public AuditProfile(String name, AuditProfileArgs args, CustomResourceOptions options)
type: oci:DataSafe:AuditProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AuditProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AuditProfileArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AuditProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuditProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuditProfileArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var auditProfileResource = new Oci.DataSafe.AuditProfile("auditProfileResource", new()
{
TargetId = "string",
CompartmentId = "string",
TargetType = "string",
IsOverrideGlobalPaidUsage = false,
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
ChangeRetentionTrigger = 0,
IsOverrideGlobalRetentionSetting = false,
IsPaidUsageEnabled = false,
OfflineMonths = 0,
OnlineMonths = 0,
Description = "string",
DefinedTags =
{
{ "string", "string" },
},
});
example, err := datasafe.NewAuditProfile(ctx, "auditProfileResource", &datasafe.AuditProfileArgs{
TargetId: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
TargetType: pulumi.String("string"),
IsOverrideGlobalPaidUsage: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ChangeRetentionTrigger: pulumi.Int(0),
IsOverrideGlobalRetentionSetting: pulumi.Bool(false),
IsPaidUsageEnabled: pulumi.Bool(false),
OfflineMonths: pulumi.Int(0),
OnlineMonths: pulumi.Int(0),
Description: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var auditProfileResource = new AuditProfile("auditProfileResource", AuditProfileArgs.builder()
.targetId("string")
.compartmentId("string")
.targetType("string")
.isOverrideGlobalPaidUsage(false)
.displayName("string")
.freeformTags(Map.of("string", "string"))
.changeRetentionTrigger(0)
.isOverrideGlobalRetentionSetting(false)
.isPaidUsageEnabled(false)
.offlineMonths(0)
.onlineMonths(0)
.description("string")
.definedTags(Map.of("string", "string"))
.build());
audit_profile_resource = oci.datasafe.AuditProfile("auditProfileResource",
target_id="string",
compartment_id="string",
target_type="string",
is_override_global_paid_usage=False,
display_name="string",
freeform_tags={
"string": "string",
},
change_retention_trigger=0,
is_override_global_retention_setting=False,
is_paid_usage_enabled=False,
offline_months=0,
online_months=0,
description="string",
defined_tags={
"string": "string",
})
const auditProfileResource = new oci.datasafe.AuditProfile("auditProfileResource", {
targetId: "string",
compartmentId: "string",
targetType: "string",
isOverrideGlobalPaidUsage: false,
displayName: "string",
freeformTags: {
string: "string",
},
changeRetentionTrigger: 0,
isOverrideGlobalRetentionSetting: false,
isPaidUsageEnabled: false,
offlineMonths: 0,
onlineMonths: 0,
description: "string",
definedTags: {
string: "string",
},
});
type: oci:DataSafe:AuditProfile
properties:
changeRetentionTrigger: 0
compartmentId: string
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
isOverrideGlobalPaidUsage: false
isOverrideGlobalRetentionSetting: false
isPaidUsageEnabled: false
offlineMonths: 0
onlineMonths: 0
targetId: string
targetType: string
AuditProfile Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AuditProfile resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- Target
Type string - The resource type that is represented by the audit profile.
- Change
Retention intTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) The description of the audit profile.
- Display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Dictionary<string, string>
- (Updatable) 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"}
- Is
Override boolGlobal Paid Usage - (Updatable) 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.
- Is
Override boolGlobal Retention Setting - 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.
- Is
Paid boolUsage Enabled - (Updatable) 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.
- Offline
Months int - 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.
- Online
Months int - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- Compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- Target
Type string - The resource type that is represented by the audit profile.
- Change
Retention intTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) The description of the audit profile.
- Display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- map[string]string
- (Updatable) 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"}
- Is
Override boolGlobal Paid Usage - (Updatable) 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.
- Is
Override boolGlobal Retention Setting - 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.
- Is
Paid boolUsage Enabled - (Updatable) 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.
- Offline
Months int - 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.
- Online
Months int - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- compartment
Id String - (Updatable) The OCID of the compartment where you want to create the audit profile.
- target
Id String - The OCID of the target database or target database group for which the audit profile is created.
- target
Type String - The resource type that is represented by the audit profile.
- change
Retention IntegerTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) The description of the audit profile.
- display
Name String - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Map<String,String>
- (Updatable) 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"}
- is
Override BooleanGlobal Paid Usage - (Updatable) 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.
- is
Override BooleanGlobal Retention Setting - 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.
- is
Paid BooleanUsage Enabled - (Updatable) 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.
- offline
Months Integer - 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.
- online
Months Integer - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- target
Type string - The resource type that is represented by the audit profile.
- change
Retention numberTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) The description of the audit profile.
- display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- {[key: string]: string}
- (Updatable) 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"}
- is
Override booleanGlobal Paid Usage - (Updatable) 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.
- is
Override booleanGlobal Retention Setting - 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.
- is
Paid booleanUsage Enabled - (Updatable) 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.
- offline
Months 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.
- online
Months number - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- compartment_
id str - (Updatable) The OCID of the compartment where you want to create the audit profile.
- target_
id str - The OCID of the target database or target database group for which the audit profile is created.
- target_
type str - The resource type that is represented by the audit profile.
- change_
retention_ inttrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) The description of the audit profile.
- display_
name str - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Mapping[str, str]
- (Updatable) 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"}
- is_
override_ boolglobal_ paid_ usage - (Updatable) 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.
- is_
override_ boolglobal_ retention_ setting - 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.
- is_
paid_ boolusage_ enabled - (Updatable) 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.
- offline_
months int - 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.
- online_
months int - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- compartment
Id String - (Updatable) The OCID of the compartment where you want to create the audit profile.
- target
Id String - The OCID of the target database or target database group for which the audit profile is created.
- target
Type String - The resource type that is represented by the audit profile.
- change
Retention NumberTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) The description of the audit profile.
- display
Name String - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Map<String>
- (Updatable) 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"}
- is
Override BooleanGlobal Paid Usage - (Updatable) 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.
- is
Override BooleanGlobal Retention Setting - 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.
- is
Paid BooleanUsage Enabled - (Updatable) 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.
- offline
Months 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.
- online
Months Number - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
Outputs
All input properties are implicitly available as output properties. Additionally, the AuditProfile resource produces the following output properties:
- Audit
Collected stringVolume - 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.
- Audit
Trails List<AuditProfile Audit Trail> - Contains the list of available audit trails on the target database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- Offline
Months stringSource - 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.
- Online
Months stringSource - 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.
- Paid
Usage stringSource - 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.
- State string
- The current state of the audit profile.
- Dictionary<string, string>
- 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"}
- Time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- Audit
Collected stringVolume - 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.
- Audit
Trails []AuditProfile Audit Trail - Contains the list of available audit trails on the target database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- Offline
Months stringSource - 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.
- Online
Months stringSource - 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.
- Paid
Usage stringSource - 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.
- State string
- The current state of the audit profile.
- map[string]string
- 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"}
- Time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit
Collected StringVolume - 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.
- audit
Trails List<AuditProfile Audit Trail> - Contains the list of available audit trails on the target database.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Details about the current state of the audit profile in Data Safe.
- offline
Months StringSource - 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.
- online
Months StringSource - 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.
- paid
Usage StringSource - 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.
- state String
- The current state of the audit profile.
- Map<String,String>
- 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"}
- time
Created String - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Updated String - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit
Collected stringVolume - 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.
- audit
Trails AuditProfile Audit Trail[] - Contains the list of available audit trails on the target database.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- offline
Months stringSource - 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.
- online
Months stringSource - 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.
- paid
Usage stringSource - 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.
- state string
- The current state of the audit profile.
- {[key: string]: string}
- 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"}
- time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit_
collected_ strvolume - 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.
- audit_
trails Sequence[AuditProfile Audit Trail] - Contains the list of available audit trails on the target database.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - Details about the current state of the audit profile in Data Safe.
- offline_
months_ strsource - 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.
- online_
months_ strsource - 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.
- paid_
usage_ strsource - 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.
- state str
- The current state of the audit profile.
- Mapping[str, str]
- 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"}
- time_
created str - The date and time the audit profile was created, in the format defined by RFC3339.
- time_
updated str - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit
Collected StringVolume - 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.
- audit
Trails List<Property Map> - Contains the list of available audit trails on the target database.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Details about the current state of the audit profile in Data Safe.
- offline
Months StringSource - 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.
- online
Months StringSource - 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.
- paid
Usage StringSource - 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.
- state String
- The current state of the audit profile.
- Map<String>
- 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"}
- time
Created String - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Updated String - The date and time the audit profile was updated, in the format defined by RFC3339.
Look up Existing AuditProfile Resource
Get an existing AuditProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AuditProfileState, opts?: CustomResourceOptions): AuditProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
audit_collected_volume: Optional[str] = None,
audit_trails: Optional[Sequence[AuditProfileAuditTrailArgs]] = None,
change_retention_trigger: Optional[int] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_override_global_paid_usage: Optional[bool] = None,
is_override_global_retention_setting: Optional[bool] = None,
is_paid_usage_enabled: Optional[bool] = None,
lifecycle_details: Optional[str] = None,
offline_months: Optional[int] = None,
offline_months_source: Optional[str] = None,
online_months: Optional[int] = None,
online_months_source: Optional[str] = None,
paid_usage_source: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
target_id: Optional[str] = None,
target_type: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> AuditProfile
func GetAuditProfile(ctx *Context, name string, id IDInput, state *AuditProfileState, opts ...ResourceOption) (*AuditProfile, error)
public static AuditProfile Get(string name, Input<string> id, AuditProfileState? state, CustomResourceOptions? opts = null)
public static AuditProfile get(String name, Output<String> id, AuditProfileState state, CustomResourceOptions options)
resources: _: type: oci:DataSafe:AuditProfile get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Audit
Collected stringVolume - 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.
- Audit
Trails List<AuditProfile Audit Trail> - Contains the list of available audit trails on the target database.
- Change
Retention intTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) The description of the audit profile.
- Display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Dictionary<string, string>
- (Updatable) 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"}
- Is
Override boolGlobal Paid Usage - (Updatable) 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.
- Is
Override boolGlobal Retention Setting - 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.
- Is
Paid boolUsage Enabled - (Updatable) 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.
- Lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- Offline
Months int - 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.
- Offline
Months stringSource - 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.
- Online
Months int - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- Online
Months stringSource - 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.
- Paid
Usage stringSource - 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.
- State string
- The current state of the audit profile.
- Dictionary<string, string>
- 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"}
- Target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- Target
Type string - The resource type that is represented by the audit profile.
- Time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- Audit
Collected stringVolume - 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.
- Audit
Trails []AuditProfile Audit Trail Args - Contains the list of available audit trails on the target database.
- Change
Retention intTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) The description of the audit profile.
- Display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- map[string]string
- (Updatable) 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"}
- Is
Override boolGlobal Paid Usage - (Updatable) 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.
- Is
Override boolGlobal Retention Setting - 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.
- Is
Paid boolUsage Enabled - (Updatable) 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.
- Lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- Offline
Months int - 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.
- Offline
Months stringSource - 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.
- Online
Months int - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- Online
Months stringSource - 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.
- Paid
Usage stringSource - 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.
- State string
- The current state of the audit profile.
- map[string]string
- 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"}
- Target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- Target
Type string - The resource type that is represented by the audit profile.
- Time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit
Collected StringVolume - 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.
- audit
Trails List<AuditProfile Audit Trail> - Contains the list of available audit trails on the target database.
- change
Retention IntegerTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) The description of the audit profile.
- display
Name String - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Map<String,String>
- (Updatable) 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"}
- is
Override BooleanGlobal Paid Usage - (Updatable) 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.
- is
Override BooleanGlobal Retention Setting - 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.
- is
Paid BooleanUsage Enabled - (Updatable) 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.
- lifecycle
Details String - Details about the current state of the audit profile in Data Safe.
- offline
Months Integer - 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.
- offline
Months StringSource - 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.
- online
Months Integer - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- online
Months StringSource - 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.
- paid
Usage StringSource - 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.
- state String
- The current state of the audit profile.
- Map<String,String>
- 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"}
- target
Id String - The OCID of the target database or target database group for which the audit profile is created.
- target
Type String - The resource type that is represented by the audit profile.
- time
Created String - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Updated String - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit
Collected stringVolume - 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.
- audit
Trails AuditProfile Audit Trail[] - Contains the list of available audit trails on the target database.
- change
Retention numberTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) The description of the audit profile.
- display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- {[key: string]: string}
- (Updatable) 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"}
- is
Override booleanGlobal Paid Usage - (Updatable) 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.
- is
Override booleanGlobal Retention Setting - 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.
- is
Paid booleanUsage Enabled - (Updatable) 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.
- lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- offline
Months 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.
- offline
Months stringSource - 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.
- online
Months number - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- online
Months stringSource - 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.
- paid
Usage stringSource - 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.
- state string
- The current state of the audit profile.
- {[key: string]: string}
- 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"}
- target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- target
Type string - The resource type that is represented by the audit profile.
- time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit_
collected_ strvolume - 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.
- audit_
trails Sequence[AuditProfile Audit Trail Args] - Contains the list of available audit trails on the target database.
- change_
retention_ inttrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) The description of the audit profile.
- display_
name str - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Mapping[str, str]
- (Updatable) 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"}
- is_
override_ boolglobal_ paid_ usage - (Updatable) 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.
- is_
override_ boolglobal_ retention_ setting - 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.
- is_
paid_ boolusage_ enabled - (Updatable) 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.
- lifecycle_
details str - Details about the current state of the audit profile in Data Safe.
- offline_
months int - 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.
- offline_
months_ strsource - 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.
- online_
months int - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- online_
months_ strsource - 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.
- paid_
usage_ strsource - 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.
- state str
- The current state of the audit profile.
- Mapping[str, str]
- 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"}
- target_
id str - The OCID of the target database or target database group for which the audit profile is created.
- target_
type str - The resource type that is represented by the audit profile.
- time_
created str - The date and time the audit profile was created, in the format defined by RFC3339.
- time_
updated str - The date and time the audit profile was updated, in the format defined by RFC3339.
- audit
Collected StringVolume - 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.
- audit
Trails List<Property Map> - Contains the list of available audit trails on the target database.
- change
Retention NumberTrigger (Updatable) An optional property when incremented triggers Change Retention. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) The description of the audit profile.
- display
Name String - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Map<String>
- (Updatable) 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"}
- is
Override BooleanGlobal Paid Usage - (Updatable) 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.
- is
Override BooleanGlobal Retention Setting - 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.
- is
Paid BooleanUsage Enabled - (Updatable) 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.
- lifecycle
Details String - Details about the current state of the audit profile in Data Safe.
- offline
Months 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.
- offline
Months StringSource - 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.
- online
Months Number - Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months
- online
Months StringSource - 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.
- paid
Usage StringSource - 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.
- state String
- The current state of the audit profile.
- Map<String>
- 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"}
- target
Id String - The OCID of the target database or target database group for which the audit profile is created.
- target
Type String - The resource type that is represented by the audit profile.
- time
Created String - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Updated String - The date and time the audit profile was updated, in the format defined by RFC3339.
Supporting Types
AuditProfileAuditTrail, AuditProfileAuditTrailArgs
- Audit
Collection stringStart Time - The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- Audit
Profile stringId - The OCID of the parent audit.
- Can
Update boolLast Archive Time On Target - Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.
- Compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) The description of the audit profile.
- Display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Dictionary<string, string>
- (Updatable) 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"}
- Id string
- The OCID of the audit profile.
- Is
Auto boolPurge Enabled - Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.
- Lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- Peer
Target intDatabase Key - The secondary id assigned for the peer database registered with Data Safe.
- Purge
Job stringDetails - The details of the audit trail purge job that ran on the "purgeJobTime".
- Purge
Job stringStatus - The current status of the audit trail purge job.
- Purge
Job stringTime - The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339.
- State string
- The current state of the audit profile.
- Status string
- The current sub-state of the audit trail.
- Dictionary<string, string>
- 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"}
- Target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- Time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- Time
Last stringCollected - The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
- Time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- Trail
Location string - An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- Trail
Source string - The underlying source of unified audit trail.
- Work
Request stringId - The OCID of the workrequest for audit trail which collects audit records.
- Audit
Collection stringStart Time - The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- Audit
Profile stringId - The OCID of the parent audit.
- Can
Update boolLast Archive Time On Target - Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.
- Compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) The description of the audit profile.
- Display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- map[string]string
- (Updatable) 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"}
- Id string
- The OCID of the audit profile.
- Is
Auto boolPurge Enabled - Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.
- Lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- Peer
Target intDatabase Key - The secondary id assigned for the peer database registered with Data Safe.
- Purge
Job stringDetails - The details of the audit trail purge job that ran on the "purgeJobTime".
- Purge
Job stringStatus - The current status of the audit trail purge job.
- Purge
Job stringTime - The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339.
- State string
- The current state of the audit profile.
- Status string
- The current sub-state of the audit trail.
- map[string]string
- 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"}
- Target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- Time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- Time
Last stringCollected - The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
- Time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- Trail
Location string - An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- Trail
Source string - The underlying source of unified audit trail.
- Work
Request stringId - The OCID of the workrequest for audit trail which collects audit records.
- audit
Collection StringStart Time - The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- audit
Profile StringId - The OCID of the parent audit.
- can
Update BooleanLast Archive Time On Target - Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.
- compartment
Id String - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) The description of the audit profile.
- display
Name String - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Map<String,String>
- (Updatable) 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"}
- id String
- The OCID of the audit profile.
- is
Auto BooleanPurge Enabled - Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.
- lifecycle
Details String - Details about the current state of the audit profile in Data Safe.
- peer
Target IntegerDatabase Key - The secondary id assigned for the peer database registered with Data Safe.
- purge
Job StringDetails - The details of the audit trail purge job that ran on the "purgeJobTime".
- purge
Job StringStatus - The current status of the audit trail purge job.
- purge
Job StringTime - The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339.
- state String
- The current state of the audit profile.
- status String
- The current sub-state of the audit trail.
- Map<String,String>
- 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"}
- target
Id String - The OCID of the target database or target database group for which the audit profile is created.
- time
Created String - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Last StringCollected - The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
- time
Updated String - The date and time the audit profile was updated, in the format defined by RFC3339.
- trail
Location String - An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- trail
Source String - The underlying source of unified audit trail.
- work
Request StringId - The OCID of the workrequest for audit trail which collects audit records.
- audit
Collection stringStart Time - The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- audit
Profile stringId - The OCID of the parent audit.
- can
Update booleanLast Archive Time On Target - Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.
- compartment
Id string - (Updatable) The OCID of the compartment where you want to create the audit profile.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) The description of the audit profile.
- display
Name string - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- {[key: string]: string}
- (Updatable) 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"}
- id string
- The OCID of the audit profile.
- is
Auto booleanPurge Enabled - Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.
- lifecycle
Details string - Details about the current state of the audit profile in Data Safe.
- peer
Target numberDatabase Key - The secondary id assigned for the peer database registered with Data Safe.
- purge
Job stringDetails - The details of the audit trail purge job that ran on the "purgeJobTime".
- purge
Job stringStatus - The current status of the audit trail purge job.
- purge
Job stringTime - The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339.
- state string
- The current state of the audit profile.
- status string
- The current sub-state of the audit trail.
- {[key: string]: string}
- 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"}
- target
Id string - The OCID of the target database or target database group for which the audit profile is created.
- time
Created string - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Last stringCollected - The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
- time
Updated string - The date and time the audit profile was updated, in the format defined by RFC3339.
- trail
Location string - An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- trail
Source string - The underlying source of unified audit trail.
- work
Request stringId - The OCID of the workrequest for audit trail which collects audit records.
- audit_
collection_ strstart_ time - The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- audit_
profile_ strid - The OCID of the parent audit.
- can_
update_ boollast_ archive_ time_ on_ target - Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.
- compartment_
id str - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) The description of the audit profile.
- display_
name str - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Mapping[str, str]
- (Updatable) 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"}
- id str
- The OCID of the audit profile.
- is_
auto_ boolpurge_ enabled - Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.
- lifecycle_
details str - Details about the current state of the audit profile in Data Safe.
- peer_
target_ intdatabase_ key - The secondary id assigned for the peer database registered with Data Safe.
- purge_
job_ strdetails - The details of the audit trail purge job that ran on the "purgeJobTime".
- purge_
job_ strstatus - The current status of the audit trail purge job.
- purge_
job_ strtime - The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339.
- state str
- The current state of the audit profile.
- status str
- The current sub-state of the audit trail.
- Mapping[str, str]
- 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"}
- target_
id str - The OCID of the target database or target database group for which the audit profile is created.
- time_
created str - The date and time the audit profile was created, in the format defined by RFC3339.
- time_
last_ strcollected - The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
- time_
updated str - The date and time the audit profile was updated, in the format defined by RFC3339.
- trail_
location str - An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- trail_
source str - The underlying source of unified audit trail.
- work_
request_ strid - The OCID of the workrequest for audit trail which collects audit records.
- audit
Collection StringStart Time - The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- audit
Profile StringId - The OCID of the parent audit.
- can
Update BooleanLast Archive Time On Target - Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.
- compartment
Id String - (Updatable) The OCID of the compartment where you want to create the audit profile.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) The description of the audit profile.
- display
Name String - (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable.
- Map<String>
- (Updatable) 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"}
- id String
- The OCID of the audit profile.
- is
Auto BooleanPurge Enabled - Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.
- lifecycle
Details String - Details about the current state of the audit profile in Data Safe.
- peer
Target NumberDatabase Key - The secondary id assigned for the peer database registered with Data Safe.
- purge
Job StringDetails - The details of the audit trail purge job that ran on the "purgeJobTime".
- purge
Job StringStatus - The current status of the audit trail purge job.
- purge
Job StringTime - The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339.
- state String
- The current state of the audit profile.
- status String
- The current sub-state of the audit trail.
- Map<String>
- 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"}
- target
Id String - The OCID of the target database or target database group for which the audit profile is created.
- time
Created String - The date and time the audit profile was created, in the format defined by RFC3339.
- time
Last StringCollected - The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
- time
Updated String - The date and time the audit profile was updated, in the format defined by RFC3339.
- trail
Location String - An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- trail
Source String - The underlying source of unified audit trail.
- work
Request StringId - The OCID of the workrequest for audit trail which collects audit records.
Import
AuditProfiles can be imported using the id
, e.g.
$ pulumi import oci:DataSafe/auditProfile:AuditProfile test_audit_profile "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.