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

oci.DataCatalog.Catalog

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 Catalog resource in Oracle Cloud Infrastructure Data Catalog service.

    Creates a new data catalog instance that includes a console and an API URL for managing metadata operations. For more information, please see the documentation.

    Example Usage

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

const testCatalog = new oci.datacatalog.Catalog("test_catalog", {
    compartmentId: compartmentId,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    displayName: catalogDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
});

    import pulumi
import pulumi_oci as oci

test_catalog = oci.data_catalog.Catalog("test_catalog",
    compartment_id=compartment_id,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    display_name=catalog_display_name,
    freeform_tags={
        "bar-key": "value",
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataCatalog.NewCatalog(ctx, "test_catalog", &DataCatalog.CatalogArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			DisplayName: pulumi.Any(catalogDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
		})
		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 testCatalog = new Oci.DataCatalog.Catalog("test_catalog", new()
    {
        CompartmentId = compartmentId,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DisplayName = catalogDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataCatalog.Catalog;
import com.pulumi.oci.DataCatalog.CatalogArgs;
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 testCatalog = new Catalog("testCatalog", CatalogArgs.builder()
            .compartmentId(compartmentId)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .displayName(catalogDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}

    resources:
  testCatalog:
    type: oci:DataCatalog:Catalog
    name: test_catalog
    properties:
      compartmentId: ${compartmentId}
      definedTags:
        foo-namespace.bar-key: value
      displayName: ${catalogDisplayName}
      freeformTags:
        bar-key: value

    Create Catalog Resource

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

    Constructor syntax

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

@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            attached_catalog_private_endpoints: Optional[Sequence[str]] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None)
    func NewCatalog(ctx *Context, name string, args CatalogArgs, opts ...ResourceOption) (*Catalog, error)
    public Catalog(string name, CatalogArgs args, CustomResourceOptions? opts = null)
    public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)

    type: oci:DataCatalog:Catalog
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 CatalogArgs
    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 CatalogArgs
    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 CatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogArgs
    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 catalogResource = new Oci.DataCatalog.Catalog("catalogResource", new()
{
    CompartmentId = "string",
    AttachedCatalogPrivateEndpoints = new[]
    {
        "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := DataCatalog.NewCatalog(ctx, "catalogResource", &DataCatalog.CatalogArgs{
	CompartmentId: pulumi.String("string"),
	AttachedCatalogPrivateEndpoints: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
    .compartmentId("string")
    .attachedCatalogPrivateEndpoints("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    catalog_resource = oci.data_catalog.Catalog("catalogResource",
    compartment_id="string",
    attached_catalog_private_endpoints=["string"],
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const catalogResource = new oci.datacatalog.Catalog("catalogResource", {
    compartmentId: "string",
    attachedCatalogPrivateEndpoints: ["string"],
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:DataCatalog:Catalog
properties:
    attachedCatalogPrivateEndpoints:
        - string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string

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

    CompartmentId string
    (Updatable) Compartment identifier.
    AttachedCatalogPrivateEndpoints List<string>

    (Updatable) The list of private reverse connection endpoints attached to the catalog

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

    DefinedTags Dictionary<string, string>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Data catalog identifier.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    CompartmentId string
    (Updatable) Compartment identifier.
    AttachedCatalogPrivateEndpoints []string

    (Updatable) The list of private reverse connection endpoints attached to the catalog

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

    DefinedTags map[string]string
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Data catalog identifier.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    compartmentId String
    (Updatable) Compartment identifier.
    attachedCatalogPrivateEndpoints List<String>

    (Updatable) The list of private reverse connection endpoints attached to the catalog

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

    definedTags Map<String,String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Data catalog identifier.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    compartmentId string
    (Updatable) Compartment identifier.
    attachedCatalogPrivateEndpoints string[]

    (Updatable) The list of private reverse connection endpoints attached to the catalog

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

    definedTags {[key: string]: string}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) Data catalog identifier.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    compartment_id str
    (Updatable) Compartment identifier.
    attached_catalog_private_endpoints Sequence[str]

    (Updatable) The list of private reverse connection endpoints attached to the catalog

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

    defined_tags Mapping[str, str]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) Data catalog identifier.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    compartmentId String
    (Updatable) Compartment identifier.
    attachedCatalogPrivateEndpoints List<String>

    (Updatable) The list of private reverse connection endpoints attached to the catalog

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

    definedTags Map<String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Data catalog identifier.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    Locks List<CatalogLock>
    Locks associated with this resource.
    NumberOfObjects int
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    ServiceApiUrl string
    The REST front endpoint URL to the data catalog instance.
    ServiceConsoleUrl string
    The console front endpoint URL to the data catalog instance.
    State string
    The current state of the data catalog resource.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    Locks []CatalogLock
    Locks associated with this resource.
    NumberOfObjects int
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    ServiceApiUrl string
    The REST front endpoint URL to the data catalog instance.
    ServiceConsoleUrl string
    The console front endpoint URL to the data catalog instance.
    State string
    The current state of the data catalog resource.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks List<CatalogLock>
    Locks associated with this resource.
    numberOfObjects Integer
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    serviceApiUrl String
    The REST front endpoint URL to the data catalog instance.
    serviceConsoleUrl String
    The console front endpoint URL to the data catalog instance.
    state String
    The current state of the data catalog resource.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the data catalog was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks CatalogLock[]
    Locks associated with this resource.
    numberOfObjects number
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    serviceApiUrl string
    The REST front endpoint URL to the data catalog instance.
    serviceConsoleUrl string
    The console front endpoint URL to the data catalog instance.
    state string
    The current state of the data catalog resource.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks Sequence[datacatalog.CatalogLock]
    Locks associated with this resource.
    number_of_objects int
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    service_api_url str
    The REST front endpoint URL to the data catalog instance.
    service_console_url str
    The console front endpoint URL to the data catalog instance.
    state str
    The current state of the data catalog resource.
    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. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the data catalog was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks List<Property Map>
    Locks associated with this resource.
    numberOfObjects Number
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    serviceApiUrl String
    The REST front endpoint URL to the data catalog instance.
    serviceConsoleUrl String
    The console front endpoint URL to the data catalog instance.
    state String
    The current state of the data catalog resource.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the data catalog was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the data catalog was updated. An RFC3339 formatted datetime string.

    Look up Existing Catalog Resource

    Get an existing Catalog 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?: CatalogState, opts?: CustomResourceOptions): Catalog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attached_catalog_private_endpoints: Optional[Sequence[str]] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[_datacatalog.CatalogLockArgs]] = None,
        number_of_objects: Optional[int] = None,
        service_api_url: Optional[str] = None,
        service_console_url: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Catalog
    func GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)
    public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)
    public static Catalog get(String name, Output<String> id, CatalogState 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:
    AttachedCatalogPrivateEndpoints List<string>

    (Updatable) The list of private reverse connection endpoints attached to the catalog

    ** 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) Compartment identifier.
    DefinedTags Dictionary<string, string>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Data catalog identifier.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    Locks List<CatalogLock>
    Locks associated with this resource.
    NumberOfObjects int
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    ServiceApiUrl string
    The REST front endpoint URL to the data catalog instance.
    ServiceConsoleUrl string
    The console front endpoint URL to the data catalog instance.
    State string
    The current state of the data catalog resource.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    AttachedCatalogPrivateEndpoints []string

    (Updatable) The list of private reverse connection endpoints attached to the catalog

    ** 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) Compartment identifier.
    DefinedTags map[string]string
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Data catalog identifier.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    Locks []CatalogLockArgs
    Locks associated with this resource.
    NumberOfObjects int
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    ServiceApiUrl string
    The REST front endpoint URL to the data catalog instance.
    ServiceConsoleUrl string
    The console front endpoint URL to the data catalog instance.
    State string
    The current state of the data catalog resource.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    attachedCatalogPrivateEndpoints List<String>

    (Updatable) The list of private reverse connection endpoints attached to the catalog

    ** 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) Compartment identifier.
    definedTags Map<String,String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Data catalog identifier.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks List<CatalogLock>
    Locks associated with this resource.
    numberOfObjects Integer
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    serviceApiUrl String
    The REST front endpoint URL to the data catalog instance.
    serviceConsoleUrl String
    The console front endpoint URL to the data catalog instance.
    state String
    The current state of the data catalog resource.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the data catalog was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    attachedCatalogPrivateEndpoints string[]

    (Updatable) The list of private reverse connection endpoints attached to the catalog

    ** 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) Compartment identifier.
    definedTags {[key: string]: string}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) Data catalog identifier.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails string
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks CatalogLock[]
    Locks associated with this resource.
    numberOfObjects number
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    serviceApiUrl string
    The REST front endpoint URL to the data catalog instance.
    serviceConsoleUrl string
    The console front endpoint URL to the data catalog instance.
    state string
    The current state of the data catalog resource.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    attached_catalog_private_endpoints Sequence[str]

    (Updatable) The list of private reverse connection endpoints attached to the catalog

    ** 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) Compartment identifier.
    defined_tags Mapping[str, str]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) Data catalog identifier.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycle_details str
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks Sequence[datacatalog.CatalogLockArgs]
    Locks associated with this resource.
    number_of_objects int
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    service_api_url str
    The REST front endpoint URL to the data catalog instance.
    service_console_url str
    The console front endpoint URL to the data catalog instance.
    state str
    The current state of the data catalog resource.
    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. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the data catalog was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the data catalog was updated. An RFC3339 formatted datetime string.
    attachedCatalogPrivateEndpoints List<String>

    (Updatable) The list of private reverse connection endpoints attached to the catalog

    ** 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) Compartment identifier.
    definedTags Map<String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Data catalog identifier.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
    locks List<Property Map>
    Locks associated with this resource.
    numberOfObjects Number
    The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
    serviceApiUrl String
    The REST front endpoint URL to the data catalog instance.
    serviceConsoleUrl String
    The console front endpoint URL to the data catalog instance.
    state String
    The current state of the data catalog resource.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the data catalog was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the data catalog was updated. An RFC3339 formatted datetime string.

    Supporting Types

    CatalogLock, CatalogLockArgs

    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    Type string
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The time the data catalog was created. An RFC3339 formatted datetime string.
    type String
    Type of the lock.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated string
    The time the data catalog was created. An RFC3339 formatted datetime string.
    type string
    Type of the lock.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    The time the data catalog was created. An RFC3339 formatted datetime string.
    type str
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The time the data catalog was created. An RFC3339 formatted datetime string.
    type String
    Type of the lock.

    Import

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

    $ pulumi import oci:DataCatalog/catalog:Catalog test_catalog "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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci