1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. Catalog
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DataCatalog.Catalog

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCatalog = new Oci.DataCatalog.Catalog("testCatalog", new()
    {
        CompartmentId = @var.Compartment_id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DisplayName = @var.Catalog_display_name,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataCatalog.NewCatalog(ctx, "testCatalog", &DataCatalog.CatalogArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			DisplayName: pulumi.Any(_var.Catalog_display_name),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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(var_.compartment_id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .displayName(var_.catalog_display_name())
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}

import pulumi
import pulumi_oci as oci

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

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

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

resources:
  testCatalog:
    type: oci:DataCatalog:Catalog
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      #Optional
      definedTags:
        foo-namespace.bar-key: value
      displayName: ${var.catalog_display_name}
      freeformTags:
        bar-key: value

Create Catalog Resource

new Catalog(name: string, args: CatalogArgs, opts?: CustomResourceOptions);
@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            attached_catalog_private_endpoints: Optional[Sequence[str]] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None)
@overload
def Catalog(resource_name: str,
            args: CatalogArgs,
            opts: Optional[ResourceOptions] = 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.
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.

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

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

DefinedTags Dictionary<string, object>

(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, object>

(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

DefinedTags map[string]interface{}

(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]interface{}

(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

definedTags Map<String,Object>

(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,Object>

(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

definedTags {[key: string]: any}

(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]: any}

(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

defined_tags Mapping[str, Any]

(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, Any]

(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

definedTags Map<Any>

(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<Any>

(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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        number_of_objects: Optional[int] = None,
        service_api_url: Optional[str] = None,
        service_console_url: Optional[str] = None,
        state: Optional[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

CompartmentId string

(Updatable) Compartment identifier.

DefinedTags Dictionary<string, object>

(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, object>

(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.

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.

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

CompartmentId string

(Updatable) Compartment identifier.

DefinedTags map[string]interface{}

(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]interface{}

(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.

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.

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

compartmentId String

(Updatable) Compartment identifier.

definedTags Map<String,Object>

(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,Object>

(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.

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.

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

compartmentId string

(Updatable) Compartment identifier.

definedTags {[key: string]: any}

(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]: any}

(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.

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.

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

compartment_id str

(Updatable) Compartment identifier.

defined_tags Mapping[str, Any]

(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, Any]

(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.

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.

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

compartmentId String

(Updatable) Compartment identifier.

definedTags Map<Any>

(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<Any>

(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.

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.

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.

Import

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

 $ pulumi import oci:DataCatalog/catalog:Catalog test_catalog "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.