Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. getCatalog
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataCatalog.getCatalog

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Catalog resource in Oracle Cloud Infrastructure Data Catalog service.

    Gets a data catalog by identifier.

    Example Usage

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

const testCatalog = oci.DataCatalog.getCatalog({
    catalogId: testCatalogOciDatacatalogCatalog.id,
});

    import pulumi
import pulumi_oci as oci

test_catalog = oci.DataCatalog.get_catalog(catalog_id=test_catalog_oci_datacatalog_catalog["id"])

    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.GetCatalog(ctx, &datacatalog.GetCatalogArgs{
			CatalogId: testCatalogOciDatacatalogCatalog.Id,
		}, nil)
		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 = Oci.DataCatalog.GetCatalog.Invoke(new()
    {
        CatalogId = testCatalogOciDatacatalogCatalog.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataCatalog.DataCatalogFunctions;
import com.pulumi.oci.DataCatalog.inputs.GetCatalogArgs;
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) {
        final var testCatalog = DataCatalogFunctions.getCatalog(GetCatalogArgs.builder()
            .catalogId(testCatalogOciDatacatalogCatalog.id())
            .build());

    }
}

    variables:
  testCatalog:
    fn::invoke:
      function: oci:DataCatalog:getCatalog
      arguments:
        catalogId: ${testCatalogOciDatacatalogCatalog.id}

    Using getCatalog

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCatalog(args: GetCatalogArgs, opts?: InvokeOptions): Promise<GetCatalogResult>
function getCatalogOutput(args: GetCatalogOutputArgs, opts?: InvokeOptions): Output<GetCatalogResult>
    def get_catalog(catalog_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCatalogResult
def get_catalog_output(catalog_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCatalogResult]
    func LookupCatalog(ctx *Context, args *LookupCatalogArgs, opts ...InvokeOption) (*LookupCatalogResult, error)
func LookupCatalogOutput(ctx *Context, args *LookupCatalogOutputArgs, opts ...InvokeOption) LookupCatalogResultOutput

    > Note: This function is named LookupCatalog in the Go SDK.

    public static class GetCatalog 
{
    public static Task<GetCatalogResult> InvokeAsync(GetCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogResult> Invoke(GetCatalogInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)
public static Output<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DataCatalog/getCatalog:getCatalog
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CatalogId string
    Unique catalog identifier.
    CatalogId string
    Unique catalog identifier.
    catalogId String
    Unique catalog identifier.
    catalogId string
    Unique catalog identifier.
    catalog_id str
    Unique catalog identifier.
    catalogId String
    Unique catalog identifier.

    getCatalog Result

    The following output properties are available:

    AttachedCatalogPrivateEndpoints List<string>
    The list of private reverse connection endpoints attached to the catalog
    CatalogId string
    CompartmentId string
    Compartment identifier.
    DefinedTags Dictionary<string, string>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Data catalog identifier, which can be renamed.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    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<GetCatalogLock>
    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
    The list of private reverse connection endpoints attached to the catalog
    CatalogId string
    CompartmentId string
    Compartment identifier.
    DefinedTags map[string]string
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Data catalog identifier, which can be renamed.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    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 []GetCatalogLock
    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>
    The list of private reverse connection endpoints attached to the catalog
    catalogId String
    compartmentId String
    Compartment identifier.
    definedTags Map<String,String>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Data catalog identifier, which can be renamed.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    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<GetCatalogLock>
    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[]
    The list of private reverse connection endpoints attached to the catalog
    catalogId string
    compartmentId string
    Compartment identifier.
    definedTags {[key: string]: string}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    Data catalog identifier, which can be renamed.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    Unique identifier that is immutable on creation.
    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 GetCatalogLock[]
    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]
    The list of private reverse connection endpoints attached to the catalog
    catalog_id str
    compartment_id str
    Compartment identifier.
    defined_tags Mapping[str, str]
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    Data catalog identifier, which can be renamed.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    Unique identifier that is immutable on creation.
    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[GetCatalogLock]
    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>
    The list of private reverse connection endpoints attached to the catalog
    catalogId String
    compartmentId String
    Compartment identifier.
    definedTags Map<String>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Data catalog identifier, which can be renamed.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    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

    GetCatalogLock

    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.

    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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci