1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. AuditTrail
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.DataSafe.AuditTrail

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

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

    Updates one or more attributes of the specified audit trail.

    Create AuditTrail Resource

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

    Constructor syntax

    new AuditTrail(name: string, args: AuditTrailArgs, opts?: CustomResourceOptions);
    @overload
    def AuditTrail(resource_name: str,
                   args: AuditTrailArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuditTrail(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   audit_trail_id: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, Any]] = None,
                   description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, Any]] = None,
                   is_auto_purge_enabled: Optional[bool] = None,
                   resume_trigger: Optional[int] = None,
                   state: Optional[str] = None)
    func NewAuditTrail(ctx *Context, name string, args AuditTrailArgs, opts ...ResourceOption) (*AuditTrail, error)
    public AuditTrail(string name, AuditTrailArgs args, CustomResourceOptions? opts = null)
    public AuditTrail(String name, AuditTrailArgs args)
    public AuditTrail(String name, AuditTrailArgs args, CustomResourceOptions options)
    
    type: oci:DataSafe:AuditTrail
    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 AuditTrailArgs
    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 AuditTrailArgs
    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 AuditTrailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuditTrailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuditTrailArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var auditTrailResource = new Oci.DataSafe.AuditTrail("auditTrailResource", new()
    {
        AuditTrailId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        Description = "string",
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        IsAutoPurgeEnabled = false,
        ResumeTrigger = 0,
        State = "string",
    });
    
    example, err := DataSafe.NewAuditTrail(ctx, "auditTrailResource", &DataSafe.AuditTrailArgs{
    	AuditTrailId: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Description: pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	IsAutoPurgeEnabled: pulumi.Bool(false),
    	ResumeTrigger:      pulumi.Int(0),
    	State:              pulumi.String("string"),
    })
    
    var auditTrailResource = new AuditTrail("auditTrailResource", AuditTrailArgs.builder()        
        .auditTrailId("string")
        .definedTags(Map.of("string", "any"))
        .description("string")
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .isAutoPurgeEnabled(false)
        .resumeTrigger(0)
        .state("string")
        .build());
    
    audit_trail_resource = oci.data_safe.AuditTrail("auditTrailResource",
        audit_trail_id="string",
        defined_tags={
            "string": "any",
        },
        description="string",
        display_name="string",
        freeform_tags={
            "string": "any",
        },
        is_auto_purge_enabled=False,
        resume_trigger=0,
        state="string")
    
    const auditTrailResource = new oci.datasafe.AuditTrail("auditTrailResource", {
        auditTrailId: "string",
        definedTags: {
            string: "any",
        },
        description: "string",
        displayName: "string",
        freeformTags: {
            string: "any",
        },
        isAutoPurgeEnabled: false,
        resumeTrigger: 0,
        state: "string",
    });
    
    type: oci:DataSafe:AuditTrail
    properties:
        auditTrailId: string
        definedTags:
            string: any
        description: string
        displayName: string
        freeformTags:
            string: any
        isAutoPurgeEnabled: false
        resumeTrigger: 0
        state: string
    

    AuditTrail Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AuditTrail resource accepts the following input properties:

    AuditTrailId string
    The OCID of the audit trail.
    DefinedTags Dictionary<string, object>
    (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 changeable.
    FreeformTags Dictionary<string, object>
    (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 int

    (Updatable) An optional property when incremented triggers Resume. 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

    State string
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    AuditTrailId string
    The OCID of the audit trail.
    DefinedTags map[string]interface{}
    (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 changeable.
    FreeformTags map[string]interface{}
    (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 int

    (Updatable) An optional property when incremented triggers Resume. 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

    State string
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    auditTrailId String
    The OCID of the audit trail.
    definedTags Map<String,Object>
    (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 changeable.
    freeformTags Map<String,Object>
    (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 Integer

    (Updatable) An optional property when incremented triggers Resume. 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

    state String
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    auditTrailId string
    The OCID of the audit trail.
    definedTags {[key: string]: any}
    (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 changeable.
    freeformTags {[key: string]: any}
    (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 number

    (Updatable) An optional property when incremented triggers Resume. 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

    state string
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    audit_trail_id str
    The OCID of the audit trail.
    defined_tags Mapping[str, Any]
    (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 changeable.
    freeform_tags Mapping[str, Any]
    (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 int

    (Updatable) An optional property when incremented triggers Resume. 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

    state str
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    auditTrailId String
    The OCID of the audit trail.
    definedTags Map<Any>
    (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 changeable.
    freeformTags Map<Any>
    (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 Number

    (Updatable) An optional property when incremented triggers Resume. 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

    state String
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.

    Outputs

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

    AuditCollectionStartTime string
    The date from which the audit trail must start collecting data, in the format defined by RFC3339.
    AuditProfileId string
    The OCID of the parent audit.
    CompartmentId string
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    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.
    PeerTargetDatabaseKey int
    The secondary id assigned for the peer database registered with Data Safe.
    PurgeJobDetails string
    The details of the audit trail purge job that ran on the "purgeJobTime".
    PurgeJobStatus string
    The current status of the audit trail purge job.
    PurgeJobTime string
    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.
    Status string
    The current sub-state of the audit trail.
    SystemTags Dictionary<string, object>
    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 Data Safe target for which the audit trail is created.
    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.
    TrailSource string
    The underlying source of unified audit trail.
    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.
    AuditProfileId string
    The OCID of the parent audit.
    CompartmentId string
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    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.
    PeerTargetDatabaseKey int
    The secondary id assigned for the peer database registered with Data Safe.
    PurgeJobDetails string
    The details of the audit trail purge job that ran on the "purgeJobTime".
    PurgeJobStatus string
    The current status of the audit trail purge job.
    PurgeJobTime string
    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.
    Status string
    The current sub-state of the audit trail.
    SystemTags map[string]interface{}
    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 Data Safe target for which the audit trail is created.
    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.
    TrailSource string
    The underlying source of unified audit trail.
    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.
    auditProfileId String
    The OCID of the parent audit.
    compartmentId String
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    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.
    peerTargetDatabaseKey Integer
    The secondary id assigned for the peer database registered with Data Safe.
    purgeJobDetails String
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purgeJobStatus String
    The current status of the audit trail purge job.
    purgeJobTime String
    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.
    status String
    The current sub-state of the audit trail.
    systemTags Map<String,Object>
    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 Data Safe target for which the audit trail is created.
    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.
    trailSource String
    The underlying source of unified audit trail.
    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.
    auditProfileId string
    The OCID of the parent audit.
    compartmentId string
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    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.
    peerTargetDatabaseKey number
    The secondary id assigned for the peer database registered with Data Safe.
    purgeJobDetails string
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purgeJobStatus string
    The current status of the audit trail purge job.
    purgeJobTime string
    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.
    status string
    The current sub-state of the audit trail.
    systemTags {[key: string]: any}
    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 Data Safe target for which the audit trail is created.
    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.
    trailSource string
    The underlying source of unified audit trail.
    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.
    audit_profile_id str
    The OCID of the parent audit.
    compartment_id str
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    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.
    peer_target_database_key int
    The secondary id assigned for the peer database registered with Data Safe.
    purge_job_details str
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purge_job_status str
    The current status of the audit trail purge job.
    purge_job_time str
    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.
    status str
    The current sub-state of the audit trail.
    system_tags Mapping[str, Any]
    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 Data Safe target for which the audit trail is created.
    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.
    trail_source str
    The underlying source of unified audit trail.
    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.
    auditProfileId String
    The OCID of the parent audit.
    compartmentId String
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    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.
    peerTargetDatabaseKey Number
    The secondary id assigned for the peer database registered with Data Safe.
    purgeJobDetails String
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purgeJobStatus String
    The current status of the audit trail purge job.
    purgeJobTime String
    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.
    status String
    The current sub-state of the audit trail.
    systemTags Map<Any>
    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 Data Safe target for which the audit trail is created.
    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.
    trailSource String
    The underlying source of unified audit trail.
    workRequestId String
    The OCID of the workrequest for audit trail which collects audit records.

    Look up Existing AuditTrail Resource

    Get an existing AuditTrail 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?: AuditTrailState, opts?: CustomResourceOptions): AuditTrail
    @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,
            audit_trail_id: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            is_auto_purge_enabled: Optional[bool] = None,
            lifecycle_details: Optional[str] = None,
            peer_target_database_key: Optional[int] = None,
            purge_job_details: Optional[str] = None,
            purge_job_status: Optional[str] = None,
            purge_job_time: Optional[str] = None,
            resume_trigger: Optional[int] = None,
            state: Optional[str] = None,
            status: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = 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,
            trail_source: Optional[str] = None,
            work_request_id: Optional[str] = None) -> AuditTrail
    func GetAuditTrail(ctx *Context, name string, id IDInput, state *AuditTrailState, opts ...ResourceOption) (*AuditTrail, error)
    public static AuditTrail Get(string name, Input<string> id, AuditTrailState? state, CustomResourceOptions? opts = null)
    public static AuditTrail get(String name, Output<String> id, AuditTrailState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    AuditProfileId string
    The OCID of the parent audit.
    AuditTrailId string
    The OCID of the audit trail.
    CompartmentId string
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    DefinedTags Dictionary<string, object>
    (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 changeable.
    FreeformTags Dictionary<string, object>
    (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.
    PeerTargetDatabaseKey int
    The secondary id assigned for the peer database registered with Data Safe.
    PurgeJobDetails string
    The details of the audit trail purge job that ran on the "purgeJobTime".
    PurgeJobStatus string
    The current status of the audit trail purge job.
    PurgeJobTime string
    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.
    ResumeTrigger int

    (Updatable) An optional property when incremented triggers Resume. 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

    State string
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    Status string
    The current sub-state of the audit trail.
    SystemTags Dictionary<string, object>
    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 Data Safe target for which the audit trail is created.
    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.
    TrailSource string
    The underlying source of unified audit trail.
    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.
    AuditProfileId string
    The OCID of the parent audit.
    AuditTrailId string
    The OCID of the audit trail.
    CompartmentId string
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    DefinedTags map[string]interface{}
    (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 changeable.
    FreeformTags map[string]interface{}
    (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.
    PeerTargetDatabaseKey int
    The secondary id assigned for the peer database registered with Data Safe.
    PurgeJobDetails string
    The details of the audit trail purge job that ran on the "purgeJobTime".
    PurgeJobStatus string
    The current status of the audit trail purge job.
    PurgeJobTime string
    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.
    ResumeTrigger int

    (Updatable) An optional property when incremented triggers Resume. 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

    State string
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    Status string
    The current sub-state of the audit trail.
    SystemTags map[string]interface{}
    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 Data Safe target for which the audit trail is created.
    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.
    TrailSource string
    The underlying source of unified audit trail.
    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.
    auditProfileId String
    The OCID of the parent audit.
    auditTrailId String
    The OCID of the audit trail.
    compartmentId String
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    definedTags Map<String,Object>
    (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 changeable.
    freeformTags Map<String,Object>
    (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.
    peerTargetDatabaseKey Integer
    The secondary id assigned for the peer database registered with Data Safe.
    purgeJobDetails String
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purgeJobStatus String
    The current status of the audit trail purge job.
    purgeJobTime String
    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.
    resumeTrigger Integer

    (Updatable) An optional property when incremented triggers Resume. 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

    state String
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    status String
    The current sub-state of the audit trail.
    systemTags Map<String,Object>
    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 Data Safe target for which the audit trail is created.
    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.
    trailSource String
    The underlying source of unified audit trail.
    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.
    auditProfileId string
    The OCID of the parent audit.
    auditTrailId string
    The OCID of the audit trail.
    compartmentId string
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    definedTags {[key: string]: any}
    (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 changeable.
    freeformTags {[key: string]: any}
    (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.
    peerTargetDatabaseKey number
    The secondary id assigned for the peer database registered with Data Safe.
    purgeJobDetails string
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purgeJobStatus string
    The current status of the audit trail purge job.
    purgeJobTime string
    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.
    resumeTrigger number

    (Updatable) An optional property when incremented triggers Resume. 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

    state string
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    status string
    The current sub-state of the audit trail.
    systemTags {[key: string]: any}
    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 Data Safe target for which the audit trail is created.
    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.
    trailSource string
    The underlying source of unified audit trail.
    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.
    audit_profile_id str
    The OCID of the parent audit.
    audit_trail_id str
    The OCID of the audit trail.
    compartment_id str
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    defined_tags Mapping[str, Any]
    (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 changeable.
    freeform_tags Mapping[str, Any]
    (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.
    peer_target_database_key int
    The secondary id assigned for the peer database registered with Data Safe.
    purge_job_details str
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purge_job_status str
    The current status of the audit trail purge job.
    purge_job_time str
    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.
    resume_trigger int

    (Updatable) An optional property when incremented triggers Resume. 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

    state str
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    status str
    The current sub-state of the audit trail.
    system_tags Mapping[str, Any]
    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 Data Safe target for which the audit trail is created.
    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.
    trail_source str
    The underlying source of unified audit trail.
    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.
    auditProfileId String
    The OCID of the parent audit.
    auditTrailId String
    The OCID of the audit trail.
    compartmentId String
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    definedTags Map<Any>
    (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 changeable.
    freeformTags Map<Any>
    (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.
    peerTargetDatabaseKey Number
    The secondary id assigned for the peer database registered with Data Safe.
    purgeJobDetails String
    The details of the audit trail purge job that ran on the "purgeJobTime".
    purgeJobStatus String
    The current status of the audit trail purge job.
    purgeJobTime String
    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.
    resumeTrigger Number

    (Updatable) An optional property when incremented triggers Resume. 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

    state String
    (Updatable) The target state for the Audit Trail. Could be set to ACTIVE or INACTIVE.
    status String
    The current sub-state of the audit trail.
    systemTags Map<Any>
    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 Data Safe target for which the audit trail is created.
    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.
    trailSource String
    The underlying source of unified audit trail.
    workRequestId String
    The OCID of the workrequest for audit trail which collects audit records.

    Import

    AuditTrails can be imported using the id, e.g.

    $ pulumi import oci:DataSafe/auditTrail:AuditTrail test_audit_trail "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.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi