Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. SqlCollection
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.SqlCollection

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Sql Collection resource in Oracle Cloud Infrastructure Data Safe service.

    Creates a new SQL collection resource.

    Example Usage

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

const testSqlCollection = new oci.datasafe.SqlCollection("test_sql_collection", {
    compartmentId: compartmentId,
    dbUserName: testUser.name,
    targetId: testTarget.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: sqlCollectionDescription,
    displayName: sqlCollectionDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    sqlLevel: sqlCollectionSqlLevel,
    status: sqlCollectionStatus,
});

    import pulumi
import pulumi_oci as oci

test_sql_collection = oci.data_safe.SqlCollection("test_sql_collection",
    compartment_id=compartment_id,
    db_user_name=test_user["name"],
    target_id=test_target["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=sql_collection_description,
    display_name=sql_collection_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    sql_level=sql_collection_sql_level,
    status=sql_collection_status)

    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.NewSqlCollection(ctx, "test_sql_collection", &DataSafe.SqlCollectionArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DbUserName:    pulumi.Any(testUser.Name),
			TargetId:      pulumi.Any(testTarget.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(sqlCollectionDescription),
			DisplayName: pulumi.Any(sqlCollectionDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			SqlLevel: pulumi.Any(sqlCollectionSqlLevel),
			Status:   pulumi.Any(sqlCollectionStatus),
		})
		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 testSqlCollection = new Oci.DataSafe.SqlCollection("test_sql_collection", new()
    {
        CompartmentId = compartmentId,
        DbUserName = testUser.Name,
        TargetId = testTarget.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = sqlCollectionDescription,
        DisplayName = sqlCollectionDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        SqlLevel = sqlCollectionSqlLevel,
        Status = sqlCollectionStatus,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.SqlCollection;
import com.pulumi.oci.DataSafe.SqlCollectionArgs;
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 testSqlCollection = new SqlCollection("testSqlCollection", SqlCollectionArgs.builder()
            .compartmentId(compartmentId)
            .dbUserName(testUser.name())
            .targetId(testTarget.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(sqlCollectionDescription)
            .displayName(sqlCollectionDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .sqlLevel(sqlCollectionSqlLevel)
            .status(sqlCollectionStatus)
            .build());

    }
}

    resources:
  testSqlCollection:
    type: oci:DataSafe:SqlCollection
    name: test_sql_collection
    properties:
      compartmentId: ${compartmentId}
      dbUserName: ${testUser.name}
      targetId: ${testTarget.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${sqlCollectionDescription}
      displayName: ${sqlCollectionDisplayName}
      freeformTags:
        Department: Finance
      sqlLevel: ${sqlCollectionSqlLevel}
      status: ${sqlCollectionStatus}

    Create SqlCollection Resource

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

    Constructor syntax

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

@overload
def SqlCollection(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compartment_id: Optional[str] = None,
                  db_user_name: Optional[str] = None,
                  target_id: Optional[str] = None,
                  generate_sql_firewall_policy_trigger: Optional[bool] = None,
                  display_name: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  description: Optional[str] = None,
                  purge_logs_trigger: Optional[bool] = None,
                  refresh_log_insights_trigger: Optional[bool] = None,
                  sql_level: Optional[str] = None,
                  start_trigger: Optional[bool] = None,
                  status: Optional[str] = None,
                  stop_trigger: Optional[bool] = None,
                  defined_tags: Optional[Mapping[str, str]] = None)
    func NewSqlCollection(ctx *Context, name string, args SqlCollectionArgs, opts ...ResourceOption) (*SqlCollection, error)
    public SqlCollection(string name, SqlCollectionArgs args, CustomResourceOptions? opts = null)
    public SqlCollection(String name, SqlCollectionArgs args)
public SqlCollection(String name, SqlCollectionArgs args, CustomResourceOptions options)

    type: oci:DataSafe:SqlCollection
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 SqlCollectionArgs
    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 SqlCollectionArgs
    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 SqlCollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlCollectionArgs
    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 sqlCollectionResource = new Oci.DataSafe.SqlCollection("sqlCollectionResource", new()
{
    CompartmentId = "string",
    DbUserName = "string",
    TargetId = "string",
    GenerateSqlFirewallPolicyTrigger = false,
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    PurgeLogsTrigger = false,
    RefreshLogInsightsTrigger = false,
    SqlLevel = "string",
    StartTrigger = false,
    Status = "string",
    StopTrigger = false,
    DefinedTags = 
    {
        { "string", "string" },
    },
});

    example, err := DataSafe.NewSqlCollection(ctx, "sqlCollectionResource", &DataSafe.SqlCollectionArgs{
	CompartmentId:                    pulumi.String("string"),
	DbUserName:                       pulumi.String("string"),
	TargetId:                         pulumi.String("string"),
	GenerateSqlFirewallPolicyTrigger: pulumi.Bool(false),
	DisplayName:                      pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:               pulumi.String("string"),
	PurgeLogsTrigger:          pulumi.Bool(false),
	RefreshLogInsightsTrigger: pulumi.Bool(false),
	SqlLevel:                  pulumi.String("string"),
	StartTrigger:              pulumi.Bool(false),
	Status:                    pulumi.String("string"),
	StopTrigger:               pulumi.Bool(false),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var sqlCollectionResource = new SqlCollection("sqlCollectionResource", SqlCollectionArgs.builder()
    .compartmentId("string")
    .dbUserName("string")
    .targetId("string")
    .generateSqlFirewallPolicyTrigger(false)
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .description("string")
    .purgeLogsTrigger(false)
    .refreshLogInsightsTrigger(false)
    .sqlLevel("string")
    .startTrigger(false)
    .status("string")
    .stopTrigger(false)
    .definedTags(Map.of("string", "string"))
    .build());

    sql_collection_resource = oci.data_safe.SqlCollection("sqlCollectionResource",
    compartment_id="string",
    db_user_name="string",
    target_id="string",
    generate_sql_firewall_policy_trigger=False,
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    description="string",
    purge_logs_trigger=False,
    refresh_log_insights_trigger=False,
    sql_level="string",
    start_trigger=False,
    status="string",
    stop_trigger=False,
    defined_tags={
        "string": "string",
    })

    const sqlCollectionResource = new oci.datasafe.SqlCollection("sqlCollectionResource", {
    compartmentId: "string",
    dbUserName: "string",
    targetId: "string",
    generateSqlFirewallPolicyTrigger: false,
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    description: "string",
    purgeLogsTrigger: false,
    refreshLogInsightsTrigger: false,
    sqlLevel: "string",
    startTrigger: false,
    status: "string",
    stopTrigger: false,
    definedTags: {
        string: "string",
    },
});

    type: oci:DataSafe:SqlCollection
properties:
    compartmentId: string
    dbUserName: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    generateSqlFirewallPolicyTrigger: false
    purgeLogsTrigger: false
    refreshLogInsightsTrigger: false
    sqlLevel: string
    startTrigger: false
    status: string
    stopTrigger: false
    targetId: string

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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the SQL collection.
    DbUserName string
    The database user name.
    TargetId string
    The OCID of the target corresponding to the security policy deployment.
    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 SQL collection.
    DisplayName string
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    GenerateSqlFirewallPolicyTrigger bool
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    PurgeLogsTrigger bool
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    RefreshLogInsightsTrigger bool
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    SqlLevel string
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    StartTrigger bool
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    Status string
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    StopTrigger bool

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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the SQL collection.
    DbUserName string
    The database user name.
    TargetId string
    The OCID of the target corresponding to the security policy deployment.
    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 SQL collection.
    DisplayName string
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    GenerateSqlFirewallPolicyTrigger bool
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    PurgeLogsTrigger bool
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    RefreshLogInsightsTrigger bool
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    SqlLevel string
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    StartTrigger bool
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    Status string
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    StopTrigger bool

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

    compartmentId String
    (Updatable) The OCID of the compartment containing the SQL collection.
    dbUserName String
    The database user name.
    targetId String
    The OCID of the target corresponding to the security policy deployment.
    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 SQL collection.
    displayName String
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generateSqlFirewallPolicyTrigger Boolean
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    purgeLogsTrigger Boolean
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refreshLogInsightsTrigger Boolean
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sqlLevel String
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    startTrigger Boolean
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    status String
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stopTrigger Boolean

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

    compartmentId string
    (Updatable) The OCID of the compartment containing the SQL collection.
    dbUserName string
    The database user name.
    targetId string
    The OCID of the target corresponding to the security policy deployment.
    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 SQL collection.
    displayName string
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generateSqlFirewallPolicyTrigger boolean
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    purgeLogsTrigger boolean
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refreshLogInsightsTrigger boolean
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sqlLevel string
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    startTrigger boolean
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    status string
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stopTrigger boolean

    (Updatable) An optional property when incremented triggers Stop. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment containing the SQL collection.
    db_user_name str
    The database user name.
    target_id str
    The OCID of the target corresponding to the security policy deployment.
    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 SQL collection.
    display_name str
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generate_sql_firewall_policy_trigger bool
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    purge_logs_trigger bool
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refresh_log_insights_trigger bool
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sql_level str
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    start_trigger bool
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    status str
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stop_trigger bool

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

    compartmentId String
    (Updatable) The OCID of the compartment containing the SQL collection.
    dbUserName String
    The database user name.
    targetId String
    The OCID of the target corresponding to the security policy deployment.
    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 SQL collection.
    displayName String
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generateSqlFirewallPolicyTrigger Boolean
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    purgeLogsTrigger Boolean
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refreshLogInsightsTrigger Boolean
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sqlLevel String
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    startTrigger Boolean
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    status String
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stopTrigger Boolean

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the SQL collection in Data Safe.
    State string
    The current state of the SQL collection.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the SQL collection was created, in the format defined by RFC3339.
    TimeLastStarted string
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    TimeLastStopped string
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the SQL collection in Data Safe.
    State string
    The current state of the SQL collection.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the SQL collection was created, in the format defined by RFC3339.
    TimeLastStarted string
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    TimeLastStopped string
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the SQL collection in Data Safe.
    state String
    The current state of the SQL collection.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the SQL collection was created, in the format defined by RFC3339.
    timeLastStarted String
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    timeLastStopped String
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Details about the current state of the SQL collection in Data Safe.
    state string
    The current state of the SQL collection.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the SQL collection was created, in the format defined by RFC3339.
    timeLastStarted string
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    timeLastStopped string
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    timeUpdated string
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Details about the current state of the SQL collection in Data Safe.
    state str
    The current state of the SQL collection.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the SQL collection was created, in the format defined by RFC3339.
    time_last_started str
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    time_last_stopped str
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    time_updated str
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the SQL collection in Data Safe.
    state String
    The current state of the SQL collection.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the SQL collection was created, in the format defined by RFC3339.
    timeLastStarted String
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    timeLastStopped String
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the SQL collection was updated, in the format defined by RFC3339.

    Look up Existing SqlCollection Resource

    Get an existing SqlCollection 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?: SqlCollectionState, opts?: CustomResourceOptions): SqlCollection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        db_user_name: 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,
        generate_sql_firewall_policy_trigger: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        purge_logs_trigger: Optional[bool] = None,
        refresh_log_insights_trigger: Optional[bool] = None,
        sql_level: Optional[str] = None,
        start_trigger: Optional[bool] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        stop_trigger: Optional[bool] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        target_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_last_started: Optional[str] = None,
        time_last_stopped: Optional[str] = None,
        time_updated: Optional[str] = None) -> SqlCollection
    func GetSqlCollection(ctx *Context, name string, id IDInput, state *SqlCollectionState, opts ...ResourceOption) (*SqlCollection, error)
    public static SqlCollection Get(string name, Input<string> id, SqlCollectionState? state, CustomResourceOptions? opts = null)
    public static SqlCollection get(String name, Output<String> id, SqlCollectionState 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:
    CompartmentId string
    (Updatable) The OCID of the compartment containing the SQL collection.
    DbUserName string
    The database user name.
    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 SQL collection.
    DisplayName string
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    GenerateSqlFirewallPolicyTrigger bool
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    LifecycleDetails string
    Details about the current state of the SQL collection in Data Safe.
    PurgeLogsTrigger bool
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    RefreshLogInsightsTrigger bool
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    SqlLevel string
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    StartTrigger bool
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    State string
    The current state of the SQL collection.
    Status string
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    StopTrigger bool

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

    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetId string
    The OCID of the target corresponding to the security policy deployment.
    TimeCreated string
    The time that the SQL collection was created, in the format defined by RFC3339.
    TimeLastStarted string
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    TimeLastStopped string
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the SQL collection.
    DbUserName string
    The database user name.
    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 SQL collection.
    DisplayName string
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    GenerateSqlFirewallPolicyTrigger bool
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    LifecycleDetails string
    Details about the current state of the SQL collection in Data Safe.
    PurgeLogsTrigger bool
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    RefreshLogInsightsTrigger bool
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    SqlLevel string
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    StartTrigger bool
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    State string
    The current state of the SQL collection.
    Status string
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    StopTrigger bool

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

    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetId string
    The OCID of the target corresponding to the security policy deployment.
    TimeCreated string
    The time that the SQL collection was created, in the format defined by RFC3339.
    TimeLastStarted string
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    TimeLastStopped string
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    TimeUpdated string
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    compartmentId String
    (Updatable) The OCID of the compartment containing the SQL collection.
    dbUserName String
    The database user name.
    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 SQL collection.
    displayName String
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generateSqlFirewallPolicyTrigger Boolean
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    lifecycleDetails String
    Details about the current state of the SQL collection in Data Safe.
    purgeLogsTrigger Boolean
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refreshLogInsightsTrigger Boolean
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sqlLevel String
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    startTrigger Boolean
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    state String
    The current state of the SQL collection.
    status String
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stopTrigger Boolean

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

    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetId String
    The OCID of the target corresponding to the security policy deployment.
    timeCreated String
    The time that the SQL collection was created, in the format defined by RFC3339.
    timeLastStarted String
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    timeLastStopped String
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    compartmentId string
    (Updatable) The OCID of the compartment containing the SQL collection.
    dbUserName string
    The database user name.
    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 SQL collection.
    displayName string
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generateSqlFirewallPolicyTrigger boolean
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    lifecycleDetails string
    Details about the current state of the SQL collection in Data Safe.
    purgeLogsTrigger boolean
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refreshLogInsightsTrigger boolean
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sqlLevel string
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    startTrigger boolean
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    state string
    The current state of the SQL collection.
    status string
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stopTrigger boolean

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

    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetId string
    The OCID of the target corresponding to the security policy deployment.
    timeCreated string
    The time that the SQL collection was created, in the format defined by RFC3339.
    timeLastStarted string
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    timeLastStopped string
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    timeUpdated string
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    compartment_id str
    (Updatable) The OCID of the compartment containing the SQL collection.
    db_user_name str
    The database user name.
    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 SQL collection.
    display_name str
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generate_sql_firewall_policy_trigger bool
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    lifecycle_details str
    Details about the current state of the SQL collection in Data Safe.
    purge_logs_trigger bool
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refresh_log_insights_trigger bool
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sql_level str
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    start_trigger bool
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    state str
    The current state of the SQL collection.
    status str
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stop_trigger bool

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

    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    target_id str
    The OCID of the target corresponding to the security policy deployment.
    time_created str
    The time that the SQL collection was created, in the format defined by RFC3339.
    time_last_started str
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    time_last_stopped str
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    time_updated str
    The last date and time the SQL collection was updated, in the format defined by RFC3339.
    compartmentId String
    (Updatable) The OCID of the compartment containing the SQL collection.
    dbUserName String
    The database user name.
    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 SQL collection.
    displayName String
    (Updatable) The display name of the SQL collection. The name does not have to be unique, and it is 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"}
    generateSqlFirewallPolicyTrigger Boolean
    (Updatable) An optional property when incremented triggers Generate Sql Firewall Policy. Could be set to any integer value.
    lifecycleDetails String
    Details about the current state of the SQL collection in Data Safe.
    purgeLogsTrigger Boolean
    (Updatable) An optional property when incremented triggers Purge Logs. Could be set to any integer value.
    refreshLogInsightsTrigger Boolean
    (Updatable) An optional property when incremented triggers Refresh Log Insights. Could be set to any integer value.
    sqlLevel String
    Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.
    startTrigger Boolean
    (Updatable) An optional property when incremented triggers Start. Could be set to any integer value.
    state String
    The current state of the SQL collection.
    status String
    Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.
    stopTrigger Boolean

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

    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetId String
    The OCID of the target corresponding to the security policy deployment.
    timeCreated String
    The time that the SQL collection was created, in the format defined by RFC3339.
    timeLastStarted String
    The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.
    timeLastStopped String
    The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.
    timeUpdated String
    The last date and time the SQL collection was updated, in the format defined by RFC3339.

    Import

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

    $ pulumi import oci:DataSafe/sqlCollection:SqlCollection test_sql_collection "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 v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci