Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. AuditProfileManagement
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.AuditProfileManagement

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

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

    Updates one or more attributes of the specified audit profile.

    Example Usage

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

const testAuditProfileManagement = new oci.datasafe.AuditProfileManagement("test_audit_profile_management", {
    compartmentId: compartmentId,
    targetId: testTargetDatabase.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: auditProfileManagementDescription,
    displayName: auditProfileManagementDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    isPaidUsageEnabled: auditProfileManagementIsPaidUsageEnabled,
    changeRetentionTrigger: true,
    offlineMonths: 10,
    onlineMonths: 7,
});

    import pulumi
import pulumi_oci as oci

test_audit_profile_management = oci.data_safe.AuditProfileManagement("test_audit_profile_management",
    compartment_id=compartment_id,
    target_id=test_target_database["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=audit_profile_management_description,
    display_name=audit_profile_management_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    is_paid_usage_enabled=audit_profile_management_is_paid_usage_enabled,
    change_retention_trigger=True,
    offline_months=10,
    online_months=7)

    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.NewAuditProfileManagement(ctx, "test_audit_profile_management", &DataSafe.AuditProfileManagementArgs{
			CompartmentId: pulumi.Any(compartmentId),
			TargetId:      pulumi.Any(testTargetDatabase.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(auditProfileManagementDescription),
			DisplayName: pulumi.Any(auditProfileManagementDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsPaidUsageEnabled:     pulumi.Any(auditProfileManagementIsPaidUsageEnabled),
			ChangeRetentionTrigger: pulumi.Bool(true),
			OfflineMonths:          pulumi.Int(10),
			OnlineMonths:           pulumi.Int(7),
		})
		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 testAuditProfileManagement = new Oci.DataSafe.AuditProfileManagement("test_audit_profile_management", new()
    {
        CompartmentId = compartmentId,
        TargetId = testTargetDatabase.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = auditProfileManagementDescription,
        DisplayName = auditProfileManagementDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsPaidUsageEnabled = auditProfileManagementIsPaidUsageEnabled,
        ChangeRetentionTrigger = true,
        OfflineMonths = 10,
        OnlineMonths = 7,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.AuditProfileManagement;
import com.pulumi.oci.DataSafe.AuditProfileManagementArgs;
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 testAuditProfileManagement = new AuditProfileManagement("testAuditProfileManagement", AuditProfileManagementArgs.builder()
            .compartmentId(compartmentId)
            .targetId(testTargetDatabase.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(auditProfileManagementDescription)
            .displayName(auditProfileManagementDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .isPaidUsageEnabled(auditProfileManagementIsPaidUsageEnabled)
            .changeRetentionTrigger(true)
            .offlineMonths(10)
            .onlineMonths(7)
            .build());

    }
}

    resources:
  testAuditProfileManagement:
    type: oci:DataSafe:AuditProfileManagement
    name: test_audit_profile_management
    properties:
      compartmentId: ${compartmentId}
      targetId: ${testTargetDatabase.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${auditProfileManagementDescription}
      displayName: ${auditProfileManagementDisplayName}
      freeformTags:
        Department: Finance
      isPaidUsageEnabled: ${auditProfileManagementIsPaidUsageEnabled}
      changeRetentionTrigger: true
      offlineMonths: 10
      onlineMonths: 7

    Create AuditProfileManagement Resource

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

    Constructor syntax

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

@overload
def AuditProfileManagement(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           change_retention_trigger: Optional[bool] = None,
                           compartment_id: Optional[str] = None,
                           defined_tags: Optional[Mapping[str, str]] = None,
                           description: Optional[str] = None,
                           display_name: Optional[str] = None,
                           freeform_tags: Optional[Mapping[str, str]] = None,
                           is_override_global_retention_setting: Optional[bool] = None,
                           is_paid_usage_enabled: Optional[bool] = None,
                           offline_months: Optional[int] = None,
                           online_months: Optional[int] = None,
                           target_id: Optional[str] = None)
    func NewAuditProfileManagement(ctx *Context, name string, args *AuditProfileManagementArgs, opts ...ResourceOption) (*AuditProfileManagement, error)
    public AuditProfileManagement(string name, AuditProfileManagementArgs? args = null, CustomResourceOptions? opts = null)
    public AuditProfileManagement(String name, AuditProfileManagementArgs args)
public AuditProfileManagement(String name, AuditProfileManagementArgs args, CustomResourceOptions options)

    type: oci:DataSafe:AuditProfileManagement
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 AuditProfileManagementArgs
    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 AuditProfileManagementArgs
    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 AuditProfileManagementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuditProfileManagementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuditProfileManagementArgs
    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 auditProfileManagementResource = new Oci.DataSafe.AuditProfileManagement("auditProfileManagementResource", new()
{
    ChangeRetentionTrigger = false,
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsOverrideGlobalRetentionSetting = false,
    IsPaidUsageEnabled = false,
    OfflineMonths = 0,
    OnlineMonths = 0,
    TargetId = "string",
});

    example, err := DataSafe.NewAuditProfileManagement(ctx, "auditProfileManagementResource", &DataSafe.AuditProfileManagementArgs{
	ChangeRetentionTrigger: pulumi.Bool(false),
	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"),
	},
	IsOverrideGlobalRetentionSetting: pulumi.Bool(false),
	IsPaidUsageEnabled:               pulumi.Bool(false),
	OfflineMonths:                    pulumi.Int(0),
	OnlineMonths:                     pulumi.Int(0),
	TargetId:                         pulumi.String("string"),
})

    var auditProfileManagementResource = new AuditProfileManagement("auditProfileManagementResource", AuditProfileManagementArgs.builder()
    .changeRetentionTrigger(false)
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isOverrideGlobalRetentionSetting(false)
    .isPaidUsageEnabled(false)
    .offlineMonths(0)
    .onlineMonths(0)
    .targetId("string")
    .build());

    audit_profile_management_resource = oci.data_safe.AuditProfileManagement("auditProfileManagementResource",
    change_retention_trigger=False,
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_override_global_retention_setting=False,
    is_paid_usage_enabled=False,
    offline_months=0,
    online_months=0,
    target_id="string")

    const auditProfileManagementResource = new oci.datasafe.AuditProfileManagement("auditProfileManagementResource", {
    changeRetentionTrigger: false,
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isOverrideGlobalRetentionSetting: false,
    isPaidUsageEnabled: false,
    offlineMonths: 0,
    onlineMonths: 0,
    targetId: "string",
});

    type: oci:DataSafe:AuditProfileManagement
properties:
    changeRetentionTrigger: false
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    isOverrideGlobalRetentionSetting: false
    isPaidUsageEnabled: false
    offlineMonths: 0
    onlineMonths: 0
    targetId: string

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

    ChangeRetentionTrigger bool
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    DisplayName string
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    IsOverrideGlobalRetentionSetting bool
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    IsPaidUsageEnabled bool
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    OfflineMonths int
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    OnlineMonths int

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

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

    TargetId string
    The OCID of the target.
    ChangeRetentionTrigger bool
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    DisplayName string
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    IsOverrideGlobalRetentionSetting bool
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    IsPaidUsageEnabled bool
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    OfflineMonths int
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    OnlineMonths int

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

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

    TargetId string
    The OCID of the target.
    changeRetentionTrigger Boolean
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    displayName String
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    isOverrideGlobalRetentionSetting Boolean
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    isPaidUsageEnabled Boolean
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    offlineMonths Integer
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    onlineMonths Integer

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

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

    targetId String
    The OCID of the target.
    changeRetentionTrigger boolean
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    displayName string
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    isOverrideGlobalRetentionSetting boolean
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    isPaidUsageEnabled boolean
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    offlineMonths number
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    onlineMonths number

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

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

    targetId string
    The OCID of the target.
    change_retention_trigger bool
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    display_name str
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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_override_global_retention_setting bool
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    is_paid_usage_enabled bool
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    offline_months int
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    online_months int

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

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

    target_id str
    The OCID of the target.
    changeRetentionTrigger Boolean
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    displayName String
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    isOverrideGlobalRetentionSetting Boolean
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    isPaidUsageEnabled Boolean
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    offlineMonths Number
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    onlineMonths Number

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

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

    targetId String
    The OCID of the target.

    Outputs

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

    AuditCollectedVolume string
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the audit profile in Data Safe.
    State string
    The current state of the audit profile.
    TimeCreated string
    The date and time the audit profile was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the audit profile was updated, in the format defined by RFC3339.
    AuditCollectedVolume string
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the audit profile in Data Safe.
    State string
    The current state of the audit profile.
    TimeCreated string
    The date and time the audit profile was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the audit profile was updated, in the format defined by RFC3339.
    auditCollectedVolume String
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the audit profile in Data Safe.
    state String
    The current state of the audit profile.
    timeCreated String
    The date and time the audit profile was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the audit profile was updated, in the format defined by RFC3339.
    auditCollectedVolume string
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Details about the current state of the audit profile in Data Safe.
    state string
    The current state of the audit profile.
    timeCreated string
    The date and time the audit profile was created, in the format defined by RFC3339.
    timeUpdated string
    The date and time the audit profile was updated, in the format defined by RFC3339.
    audit_collected_volume str
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Details about the current state of the audit profile in Data Safe.
    state str
    The current state of the audit profile.
    time_created str
    The date and time the audit profile was created, in the format defined by RFC3339.
    time_updated str
    The date and time the audit profile was updated, in the format defined by RFC3339.
    auditCollectedVolume String
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the audit profile in Data Safe.
    state String
    The current state of the audit profile.
    timeCreated String
    The date and time the audit profile was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the audit profile was updated, in the format defined by RFC3339.

    Look up Existing AuditProfileManagement Resource

    Get an existing AuditProfileManagement 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?: AuditProfileManagementState, opts?: CustomResourceOptions): AuditProfileManagement
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_collected_volume: Optional[str] = None,
        change_retention_trigger: Optional[bool] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_override_global_retention_setting: Optional[bool] = None,
        is_paid_usage_enabled: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        offline_months: Optional[int] = None,
        online_months: Optional[int] = None,
        state: Optional[str] = None,
        target_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> AuditProfileManagement
    func GetAuditProfileManagement(ctx *Context, name string, id IDInput, state *AuditProfileManagementState, opts ...ResourceOption) (*AuditProfileManagement, error)
    public static AuditProfileManagement Get(string name, Input<string> id, AuditProfileManagementState? state, CustomResourceOptions? opts = null)
    public static AuditProfileManagement get(String name, Output<String> id, AuditProfileManagementState 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:
    AuditCollectedVolume string
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    ChangeRetentionTrigger bool
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    DisplayName string
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    IsOverrideGlobalRetentionSetting bool
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    IsPaidUsageEnabled bool
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    LifecycleDetails string
    Details about the current state of the audit profile in Data Safe.
    OfflineMonths int
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    OnlineMonths int

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

    ** 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
    The current state of the audit profile.
    TargetId string
    The OCID of the target.
    TimeCreated string
    The date and time the audit profile was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the audit profile was updated, in the format defined by RFC3339.
    AuditCollectedVolume string
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    ChangeRetentionTrigger bool
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    DisplayName string
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    IsOverrideGlobalRetentionSetting bool
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    IsPaidUsageEnabled bool
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    LifecycleDetails string
    Details about the current state of the audit profile in Data Safe.
    OfflineMonths int
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    OnlineMonths int

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

    ** 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
    The current state of the audit profile.
    TargetId string
    The OCID of the target.
    TimeCreated string
    The date and time the audit profile was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the audit profile was updated, in the format defined by RFC3339.
    auditCollectedVolume String
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    changeRetentionTrigger Boolean
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    displayName String
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    isOverrideGlobalRetentionSetting Boolean
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    isPaidUsageEnabled Boolean
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    lifecycleDetails String
    Details about the current state of the audit profile in Data Safe.
    offlineMonths Integer
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    onlineMonths Integer

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

    ** 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
    The current state of the audit profile.
    targetId String
    The OCID of the target.
    timeCreated String
    The date and time the audit profile was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the audit profile was updated, in the format defined by RFC3339.
    auditCollectedVolume string
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    changeRetentionTrigger boolean
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    displayName string
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    isOverrideGlobalRetentionSetting boolean
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    isPaidUsageEnabled boolean
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    lifecycleDetails string
    Details about the current state of the audit profile in Data Safe.
    offlineMonths number
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    onlineMonths number

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

    ** 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
    The current state of the audit profile.
    targetId string
    The OCID of the target.
    timeCreated string
    The date and time the audit profile was created, in the format defined by RFC3339.
    timeUpdated string
    The date and time the audit profile was updated, in the format defined by RFC3339.
    audit_collected_volume str
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    change_retention_trigger bool
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    display_name str
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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_override_global_retention_setting bool
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    is_paid_usage_enabled bool
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    lifecycle_details str
    Details about the current state of the audit profile in Data Safe.
    offline_months int
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    online_months int

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

    ** 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
    The current state of the audit profile.
    target_id str
    The OCID of the target.
    time_created str
    The date and time the audit profile was created, in the format defined by RFC3339.
    time_updated str
    The date and time the audit profile was updated, in the format defined by RFC3339.
    auditCollectedVolume String
    Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.
    changeRetentionTrigger Boolean
    (Updatable) An optional property when set to true triggers Change Retention.
    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 profile.
    displayName String
    (Updatable) The display name of the audit profile. The name does not have to be unique, and it's changeable.
    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"}
    isOverrideGlobalRetentionSetting Boolean
    Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
    isPaidUsageEnabled Boolean
    (Updatable) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.
    lifecycleDetails String
    Details about the current state of the audit profile in Data Safe.
    offlineMonths Number
    Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.
    onlineMonths Number

    Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

    ** 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
    The current state of the audit profile.
    targetId String
    The OCID of the target.
    timeCreated String
    The date and time the audit profile was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the audit profile was updated, in the format defined by RFC3339.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci