Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. AuditTrailManagement
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.AuditTrailManagement

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Audit Trail Management resource in Oracle Cloud Infrastructure Data Safe service.

    Updates one or more attributes of the specified audit trail.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAuditTrailManagement = new oci.datasafe.AuditTrailManagement("test_audit_trail_management", {
    compartmentId: compartmentId,
    targetId: testTargetDatabase.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: auditTrailManagementDescription,
    displayName: auditTrailManagementDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    isAutoPurgeEnabled: auditTrailManagementIsAutoPurgeEnabled,
});

    import pulumi
import pulumi_oci as oci

test_audit_trail_management = oci.data_safe.AuditTrailManagement("test_audit_trail_management",
    compartment_id=compartment_id,
    target_id=test_target_database["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=audit_trail_management_description,
    display_name=audit_trail_management_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    is_auto_purge_enabled=audit_trail_management_is_auto_purge_enabled)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/datasafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasafe.NewAuditTrailManagement(ctx, "test_audit_trail_management", &datasafe.AuditTrailManagementArgs{
			CompartmentId: pulumi.Any(compartmentId),
			TargetId:      pulumi.Any(testTargetDatabase.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(auditTrailManagementDescription),
			DisplayName: pulumi.Any(auditTrailManagementDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsAutoPurgeEnabled: pulumi.Any(auditTrailManagementIsAutoPurgeEnabled),
		})
		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 testAuditTrailManagement = new Oci.DataSafe.AuditTrailManagement("test_audit_trail_management", new()
    {
        CompartmentId = compartmentId,
        TargetId = testTargetDatabase.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = auditTrailManagementDescription,
        DisplayName = auditTrailManagementDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsAutoPurgeEnabled = auditTrailManagementIsAutoPurgeEnabled,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.AuditTrailManagement;
import com.pulumi.oci.DataSafe.AuditTrailManagementArgs;
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 testAuditTrailManagement = new AuditTrailManagement("testAuditTrailManagement", AuditTrailManagementArgs.builder()
            .compartmentId(compartmentId)
            .targetId(testTargetDatabase.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(auditTrailManagementDescription)
            .displayName(auditTrailManagementDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .isAutoPurgeEnabled(auditTrailManagementIsAutoPurgeEnabled)
            .build());

    }
}

    resources:
  testAuditTrailManagement:
    type: oci:DataSafe:AuditTrailManagement
    name: test_audit_trail_management
    properties:
      compartmentId: ${compartmentId}
      targetId: ${testTargetDatabase.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${auditTrailManagementDescription}
      displayName: ${auditTrailManagementDisplayName}
      freeformTags:
        Department: Finance
      isAutoPurgeEnabled: ${auditTrailManagementIsAutoPurgeEnabled}

    Create AuditTrailManagement Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuditTrailManagement(name: string, args?: AuditTrailManagementArgs, opts?: CustomResourceOptions);
    @overload
def AuditTrailManagement(resource_name: str,
                         args: Optional[AuditTrailManagementArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def AuditTrailManagement(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         audit_collection_start_time: Optional[str] = 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_auto_purge_enabled: Optional[bool] = None,
                         resume_trigger: Optional[bool] = None,
                         start_trigger: Optional[bool] = None,
                         state: Optional[str] = None,
                         stop_trigger: Optional[bool] = None,
                         target_id: Optional[str] = None,
                         trail_location: Optional[str] = None)
    func NewAuditTrailManagement(ctx *Context, name string, args *AuditTrailManagementArgs, opts ...ResourceOption) (*AuditTrailManagement, error)
    public AuditTrailManagement(string name, AuditTrailManagementArgs? args = null, CustomResourceOptions? opts = null)
    public AuditTrailManagement(String name, AuditTrailManagementArgs args)
public AuditTrailManagement(String name, AuditTrailManagementArgs args, CustomResourceOptions options)

    type: oci:DataSafe:AuditTrailManagement
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 AuditTrailManagementArgs
    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 AuditTrailManagementArgs
    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 AuditTrailManagementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuditTrailManagementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuditTrailManagementArgs
    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 auditTrailManagementResource = new Oci.DataSafe.AuditTrailManagement("auditTrailManagementResource", new()
{
    AuditCollectionStartTime = "string",
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsAutoPurgeEnabled = false,
    ResumeTrigger = false,
    StartTrigger = false,
    State = "string",
    StopTrigger = false,
    TargetId = "string",
    TrailLocation = "string",
});

    example, err := datasafe.NewAuditTrailManagement(ctx, "auditTrailManagementResource", &datasafe.AuditTrailManagementArgs{
	AuditCollectionStartTime: pulumi.String("string"),
	CompartmentId:            pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsAutoPurgeEnabled: pulumi.Bool(false),
	ResumeTrigger:      pulumi.Bool(false),
	StartTrigger:       pulumi.Bool(false),
	State:              pulumi.String("string"),
	StopTrigger:        pulumi.Bool(false),
	TargetId:           pulumi.String("string"),
	TrailLocation:      pulumi.String("string"),
})

    var auditTrailManagementResource = new AuditTrailManagement("auditTrailManagementResource", AuditTrailManagementArgs.builder()
    .auditCollectionStartTime("string")
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isAutoPurgeEnabled(false)
    .resumeTrigger(false)
    .startTrigger(false)
    .state("string")
    .stopTrigger(false)
    .targetId("string")
    .trailLocation("string")
    .build());

    audit_trail_management_resource = oci.data_safe.AuditTrailManagement("auditTrailManagementResource",
    audit_collection_start_time="string",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_auto_purge_enabled=False,
    resume_trigger=False,
    start_trigger=False,
    state="string",
    stop_trigger=False,
    target_id="string",
    trail_location="string")

    const auditTrailManagementResource = new oci.datasafe.AuditTrailManagement("auditTrailManagementResource", {
    auditCollectionStartTime: "string",
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isAutoPurgeEnabled: false,
    resumeTrigger: false,
    startTrigger: false,
    state: "string",
    stopTrigger: false,
    targetId: "string",
    trailLocation: "string",
});

    type: oci:DataSafe:AuditTrailManagement
properties:
    auditCollectionStartTime: string
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    isAutoPurgeEnabled: false
    resumeTrigger: false
    startTrigger: false
    state: string
    stopTrigger: false
    targetId: string
    trailLocation: string

    AuditTrailManagement 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 AuditTrailManagement resource accepts the following input properties:

    AuditCollectionStartTime string

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    CompartmentId string
    The OCID of the compartment that contains the target.
    DefinedTags 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 trail.
    DisplayName string
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    FreeformTags 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"}
    IsAutoPurgeEnabled bool
    (Updatable) 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.
    ResumeTrigger bool
    (Updatable) An optional property when set to true triggers Resume.
    StartTrigger bool
    (Updatable) An optional property when set to true triggers Start.
    State string
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    StopTrigger bool
    (Updatable) An optional property when set to true triggers Stop.
    TargetId string
    The OCID of the target.
    TrailLocation string
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    AuditCollectionStartTime string

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    CompartmentId string
    The OCID of the compartment that contains the target.
    DefinedTags 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 trail.
    DisplayName string
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    FreeformTags 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"}
    IsAutoPurgeEnabled bool
    (Updatable) 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.
    ResumeTrigger bool
    (Updatable) An optional property when set to true triggers Resume.
    StartTrigger bool
    (Updatable) An optional property when set to true triggers Start.
    State string
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    StopTrigger bool
    (Updatable) An optional property when set to true triggers Stop.
    TargetId string
    The OCID of the target.
    TrailLocation string
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    auditCollectionStartTime String

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    compartmentId String
    The OCID of the compartment that contains the target.
    definedTags 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 trail.
    displayName String
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeformTags 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"}
    isAutoPurgeEnabled Boolean
    (Updatable) 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.
    resumeTrigger Boolean
    (Updatable) An optional property when set to true triggers Resume.
    startTrigger Boolean
    (Updatable) An optional property when set to true triggers Start.
    state String
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    stopTrigger Boolean
    (Updatable) An optional property when set to true triggers Stop.
    targetId String
    The OCID of the target.
    trailLocation String
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    auditCollectionStartTime string

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    compartmentId string
    The OCID of the compartment that contains the target.
    definedTags {[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 trail.
    displayName string
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeformTags {[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"}
    isAutoPurgeEnabled boolean
    (Updatable) 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.
    resumeTrigger boolean
    (Updatable) An optional property when set to true triggers Resume.
    startTrigger boolean
    (Updatable) An optional property when set to true triggers Start.
    state string
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    stopTrigger boolean
    (Updatable) An optional property when set to true triggers Stop.
    targetId string
    The OCID of the target.
    trailLocation string
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    audit_collection_start_time str

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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
    The OCID of the compartment that contains the target.
    defined_tags 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 trail.
    display_name str
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeform_tags 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_auto_purge_enabled bool
    (Updatable) 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.
    resume_trigger bool
    (Updatable) An optional property when set to true triggers Resume.
    start_trigger bool
    (Updatable) An optional property when set to true triggers Start.
    state str
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    stop_trigger bool
    (Updatable) An optional property when set to true triggers Stop.
    target_id str
    The OCID of the target.
    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.
    auditCollectionStartTime String

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    compartmentId String
    The OCID of the compartment that contains the target.
    definedTags 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 trail.
    displayName String
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeformTags 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"}
    isAutoPurgeEnabled Boolean
    (Updatable) 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.
    resumeTrigger Boolean
    (Updatable) An optional property when set to true triggers Resume.
    startTrigger Boolean
    (Updatable) An optional property when set to true triggers Start.
    state String
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    stopTrigger Boolean
    (Updatable) An optional property when set to true triggers Stop.
    targetId String
    The OCID of the target.
    trailLocation String
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuditTrailManagement resource produces the following output properties:

    AuditProfileId string
    The OCID of the parent audit.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the audit trail in Data Safe.
    Status string
    The current sub-state of the audit trail.
    SystemTags 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"}
    TimeCreated string
    The date and time the audit trail was created, in the format defined by RFC3339.
    TimeLastCollected string
    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.
    TimeUpdated string
    The date and time the audit trail was updated, in the format defined by RFC3339.
    WorkRequestId string
    The OCID of the workrequest for audit trail which collects audit records.
    AuditProfileId string
    The OCID of the parent audit.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the audit trail in Data Safe.
    Status string
    The current sub-state of the audit trail.
    SystemTags 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"}
    TimeCreated string
    The date and time the audit trail was created, in the format defined by RFC3339.
    TimeLastCollected string
    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.
    TimeUpdated string
    The date and time the audit trail was updated, in the format defined by RFC3339.
    WorkRequestId string
    The OCID of the workrequest for audit trail which collects audit records.
    auditProfileId String
    The OCID of the parent audit.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the audit trail in Data Safe.
    status String
    The current sub-state of the audit trail.
    systemTags 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"}
    timeCreated String
    The date and time the audit trail was created, in the format defined by RFC3339.
    timeLastCollected String
    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.
    timeUpdated String
    The date and time the audit trail was updated, in the format defined by RFC3339.
    workRequestId String
    The OCID of the workrequest for audit trail which collects audit records.
    auditProfileId string
    The OCID of the parent audit.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Details about the current state of the audit trail in Data Safe.
    status string
    The current sub-state of the audit trail.
    systemTags {[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"}
    timeCreated string
    The date and time the audit trail was created, in the format defined by RFC3339.
    timeLastCollected string
    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.
    timeUpdated string
    The date and time the audit trail was updated, in the format defined by RFC3339.
    workRequestId string
    The OCID of the workrequest for audit trail which collects audit records.
    audit_profile_id str
    The OCID of the parent audit.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Details about the current state of the audit trail in Data Safe.
    status str
    The current sub-state of the audit trail.
    system_tags 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 trail was created, in the format defined by RFC3339.
    time_last_collected str
    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 trail was updated, in the format defined by RFC3339.
    work_request_id str
    The OCID of the workrequest for audit trail which collects audit records.
    auditProfileId String
    The OCID of the parent audit.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the audit trail in Data Safe.
    status String
    The current sub-state of the audit trail.
    systemTags 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"}
    timeCreated String
    The date and time the audit trail was created, in the format defined by RFC3339.
    timeLastCollected String
    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.
    timeUpdated String
    The date and time the audit trail was updated, in the format defined by RFC3339.
    workRequestId String
    The OCID of the workrequest for audit trail which collects audit records.

    Look up Existing AuditTrailManagement Resource

    Get an existing AuditTrailManagement 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?: AuditTrailManagementState, opts?: CustomResourceOptions): AuditTrailManagement
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_collection_start_time: Optional[str] = None,
        audit_profile_id: Optional[str] = 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_auto_purge_enabled: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        resume_trigger: Optional[bool] = None,
        start_trigger: Optional[bool] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        stop_trigger: Optional[bool] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        target_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_last_collected: Optional[str] = None,
        time_updated: Optional[str] = None,
        trail_location: Optional[str] = None,
        work_request_id: Optional[str] = None) -> AuditTrailManagement
    func GetAuditTrailManagement(ctx *Context, name string, id IDInput, state *AuditTrailManagementState, opts ...ResourceOption) (*AuditTrailManagement, error)
    public static AuditTrailManagement Get(string name, Input<string> id, AuditTrailManagementState? state, CustomResourceOptions? opts = null)
    public static AuditTrailManagement get(String name, Output<String> id, AuditTrailManagementState state, CustomResourceOptions options)
    resources:  _:    type: oci:DataSafe:AuditTrailManagement    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.
    The following state arguments are supported:
    AuditCollectionStartTime string

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    AuditProfileId string
    The OCID of the parent audit.
    CompartmentId string
    The OCID of the compartment that contains the target.
    DefinedTags 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 trail.
    DisplayName string
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    FreeformTags 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"}
    IsAutoPurgeEnabled bool
    (Updatable) 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.
    LifecycleDetails string
    Details about the current state of the audit trail in Data Safe.
    ResumeTrigger bool
    (Updatable) An optional property when set to true triggers Resume.
    StartTrigger bool
    (Updatable) An optional property when set to true triggers Start.
    State string
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    Status string
    The current sub-state of the audit trail.
    StopTrigger bool
    (Updatable) An optional property when set to true triggers Stop.
    SystemTags 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"}
    TargetId string
    The OCID of the target.
    TimeCreated string
    The date and time the audit trail was created, in the format defined by RFC3339.
    TimeLastCollected string
    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.
    TimeUpdated string
    The date and time the audit trail was updated, in the format defined by RFC3339.
    TrailLocation string
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    WorkRequestId string
    The OCID of the workrequest for audit trail which collects audit records.
    AuditCollectionStartTime string

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    AuditProfileId string
    The OCID of the parent audit.
    CompartmentId string
    The OCID of the compartment that contains the target.
    DefinedTags 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 trail.
    DisplayName string
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    FreeformTags 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"}
    IsAutoPurgeEnabled bool
    (Updatable) 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.
    LifecycleDetails string
    Details about the current state of the audit trail in Data Safe.
    ResumeTrigger bool
    (Updatable) An optional property when set to true triggers Resume.
    StartTrigger bool
    (Updatable) An optional property when set to true triggers Start.
    State string
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    Status string
    The current sub-state of the audit trail.
    StopTrigger bool
    (Updatable) An optional property when set to true triggers Stop.
    SystemTags 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"}
    TargetId string
    The OCID of the target.
    TimeCreated string
    The date and time the audit trail was created, in the format defined by RFC3339.
    TimeLastCollected string
    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.
    TimeUpdated string
    The date and time the audit trail was updated, in the format defined by RFC3339.
    TrailLocation string
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    WorkRequestId string
    The OCID of the workrequest for audit trail which collects audit records.
    auditCollectionStartTime String

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    auditProfileId String
    The OCID of the parent audit.
    compartmentId String
    The OCID of the compartment that contains the target.
    definedTags 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 trail.
    displayName String
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeformTags 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"}
    isAutoPurgeEnabled Boolean
    (Updatable) 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.
    lifecycleDetails String
    Details about the current state of the audit trail in Data Safe.
    resumeTrigger Boolean
    (Updatable) An optional property when set to true triggers Resume.
    startTrigger Boolean
    (Updatable) An optional property when set to true triggers Start.
    state String
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    status String
    The current sub-state of the audit trail.
    stopTrigger Boolean
    (Updatable) An optional property when set to true triggers Stop.
    systemTags 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"}
    targetId String
    The OCID of the target.
    timeCreated String
    The date and time the audit trail was created, in the format defined by RFC3339.
    timeLastCollected String
    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.
    timeUpdated String
    The date and time the audit trail was updated, in the format defined by RFC3339.
    trailLocation String
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    workRequestId String
    The OCID of the workrequest for audit trail which collects audit records.
    auditCollectionStartTime string

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    auditProfileId string
    The OCID of the parent audit.
    compartmentId string
    The OCID of the compartment that contains the target.
    definedTags {[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 trail.
    displayName string
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeformTags {[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"}
    isAutoPurgeEnabled boolean
    (Updatable) 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.
    lifecycleDetails string
    Details about the current state of the audit trail in Data Safe.
    resumeTrigger boolean
    (Updatable) An optional property when set to true triggers Resume.
    startTrigger boolean
    (Updatable) An optional property when set to true triggers Start.
    state string
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    status string
    The current sub-state of the audit trail.
    stopTrigger boolean
    (Updatable) An optional property when set to true triggers Stop.
    systemTags {[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"}
    targetId string
    The OCID of the target.
    timeCreated string
    The date and time the audit trail was created, in the format defined by RFC3339.
    timeLastCollected string
    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.
    timeUpdated string
    The date and time the audit trail was updated, in the format defined by RFC3339.
    trailLocation string
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    workRequestId string
    The OCID of the workrequest for audit trail which collects audit records.
    audit_collection_start_time str

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    audit_profile_id str
    The OCID of the parent audit.
    compartment_id str
    The OCID of the compartment that contains the target.
    defined_tags 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 trail.
    display_name str
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeform_tags 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_auto_purge_enabled bool
    (Updatable) 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 trail in Data Safe.
    resume_trigger bool
    (Updatable) An optional property when set to true triggers Resume.
    start_trigger bool
    (Updatable) An optional property when set to true triggers Start.
    state str
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    status str
    The current sub-state of the audit trail.
    stop_trigger bool
    (Updatable) An optional property when set to true triggers Stop.
    system_tags 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.
    time_created str
    The date and time the audit trail was created, in the format defined by RFC3339.
    time_last_collected str
    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 trail 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.
    work_request_id str
    The OCID of the workrequest for audit trail which collects audit records.
    auditCollectionStartTime String

    The date from which the audit trail must start collecting data, in the format defined by RFC3339. It is a required field when start_trigger is set.

    ** 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

    auditProfileId String
    The OCID of the parent audit.
    compartmentId String
    The OCID of the compartment that contains the target.
    definedTags 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 trail.
    displayName String
    (Updatable) The display name of the audit trail. The name does not have to be unique, and it's updatable.
    freeformTags 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"}
    isAutoPurgeEnabled Boolean
    (Updatable) 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.
    lifecycleDetails String
    Details about the current state of the audit trail in Data Safe.
    resumeTrigger Boolean
    (Updatable) An optional property when set to true triggers Resume.
    startTrigger Boolean
    (Updatable) An optional property when set to true triggers Start.
    state String
    (Updatable) The target state for the Audit Trail Management. Could be set to ACTIVE or INACTIVE.
    status String
    The current sub-state of the audit trail.
    stopTrigger Boolean
    (Updatable) An optional property when set to true triggers Stop.
    systemTags 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"}
    targetId String
    The OCID of the target.
    timeCreated String
    The date and time the audit trail was created, in the format defined by RFC3339.
    timeLastCollected String
    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.
    timeUpdated String
    The date and time the audit trail was updated, in the format defined by RFC3339.
    trailLocation String
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    workRequestId String
    The OCID of the workrequest for audit trail which collects audit records.

    Import

    Import is not supported for this resource.

    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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci