1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. getCatalogPrivateEndpoint
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.DataCatalog.getCatalogPrivateEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

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

Gets a specific private reverse connection by identifier.

Example Usage

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

const testCatalogPrivateEndpoint = oci.DataCatalog.getCatalogPrivateEndpoint({
    catalogPrivateEndpointId: testCatalogPrivateEndpointOciDatacatalogCatalogPrivateEndpoint.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_catalog_private_endpoint = oci.DataCatalog.get_catalog_private_endpoint(catalog_private_endpoint_id=test_catalog_private_endpoint_oci_datacatalog_catalog_private_endpoint["id"])
Copy
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.GetCatalogPrivateEndpoint(ctx, &datacatalog.GetCatalogPrivateEndpointArgs{
			CatalogPrivateEndpointId: testCatalogPrivateEndpointOciDatacatalogCatalogPrivateEndpoint.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCatalogPrivateEndpoint = Oci.DataCatalog.GetCatalogPrivateEndpoint.Invoke(new()
    {
        CatalogPrivateEndpointId = testCatalogPrivateEndpointOciDatacatalogCatalogPrivateEndpoint.Id,
    });

});
Copy
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.GetCatalogPrivateEndpointArgs;
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 testCatalogPrivateEndpoint = DataCatalogFunctions.getCatalogPrivateEndpoint(GetCatalogPrivateEndpointArgs.builder()
            .catalogPrivateEndpointId(testCatalogPrivateEndpointOciDatacatalogCatalogPrivateEndpoint.id())
            .build());

    }
}
Copy
variables:
  testCatalogPrivateEndpoint:
    fn::invoke:
      function: oci:DataCatalog:getCatalogPrivateEndpoint
      arguments:
        catalogPrivateEndpointId: ${testCatalogPrivateEndpointOciDatacatalogCatalogPrivateEndpoint.id}
Copy

Using getCatalogPrivateEndpoint

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 getCatalogPrivateEndpoint(args: GetCatalogPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetCatalogPrivateEndpointResult>
function getCatalogPrivateEndpointOutput(args: GetCatalogPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetCatalogPrivateEndpointResult>
Copy
def get_catalog_private_endpoint(catalog_private_endpoint_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCatalogPrivateEndpointResult
def get_catalog_private_endpoint_output(catalog_private_endpoint_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetCatalogPrivateEndpointResult]
Copy
func GetCatalogPrivateEndpoint(ctx *Context, args *GetCatalogPrivateEndpointArgs, opts ...InvokeOption) (*GetCatalogPrivateEndpointResult, error)
func GetCatalogPrivateEndpointOutput(ctx *Context, args *GetCatalogPrivateEndpointOutputArgs, opts ...InvokeOption) GetCatalogPrivateEndpointResultOutput
Copy

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

public static class GetCatalogPrivateEndpoint 
{
    public static Task<GetCatalogPrivateEndpointResult> InvokeAsync(GetCatalogPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogPrivateEndpointResult> Invoke(GetCatalogPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCatalogPrivateEndpointResult> getCatalogPrivateEndpoint(GetCatalogPrivateEndpointArgs args, InvokeOptions options)
public static Output<GetCatalogPrivateEndpointResult> getCatalogPrivateEndpoint(GetCatalogPrivateEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:DataCatalog/getCatalogPrivateEndpoint:getCatalogPrivateEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CatalogPrivateEndpointId This property is required. string
Unique private reverse connection identifier.
CatalogPrivateEndpointId This property is required. string
Unique private reverse connection identifier.
catalogPrivateEndpointId This property is required. String
Unique private reverse connection identifier.
catalogPrivateEndpointId This property is required. string
Unique private reverse connection identifier.
catalog_private_endpoint_id This property is required. str
Unique private reverse connection identifier.
catalogPrivateEndpointId This property is required. String
Unique private reverse connection identifier.

getCatalogPrivateEndpoint Result

The following output properties are available:

AttachedCatalogs List<string>
The list of catalogs using the private reverse connection endpoint
CatalogPrivateEndpointId string
CompartmentId string
Identifier of the compartment this private endpoint belongs to
DefinedTags Dictionary<string, string>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
Mutable name of the Private Reverse Connection Endpoint
DnsZones List<string>
List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Locks List<GetCatalogPrivateEndpointLock>
Locks associated with this resource.
State string
The current state of the private endpoint resource.
SubnetId string
Subnet Identifier
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 private endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time the private endpoint was updated. An RFC3339 formatted datetime string.
AttachedCatalogs []string
The list of catalogs using the private reverse connection endpoint
CatalogPrivateEndpointId string
CompartmentId string
Identifier of the compartment this private endpoint belongs to
DefinedTags map[string]string
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
Mutable name of the Private Reverse Connection Endpoint
DnsZones []string
List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Locks []GetCatalogPrivateEndpointLock
Locks associated with this resource.
State string
The current state of the private endpoint resource.
SubnetId string
Subnet Identifier
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 private endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated string
The time the private endpoint was updated. An RFC3339 formatted datetime string.
attachedCatalogs List<String>
The list of catalogs using the private reverse connection endpoint
catalogPrivateEndpointId String
compartmentId String
Identifier of the compartment this private endpoint belongs to
definedTags Map<String,String>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String
Mutable name of the Private Reverse Connection Endpoint
dnsZones List<String>
List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks List<GetCatalogPrivateEndpointLock>
Locks associated with this resource.
state String
The current state of the private endpoint resource.
subnetId String
Subnet Identifier
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 private endpoint was created. An RFC3339 formatted datetime string.
timeUpdated String
The time the private endpoint was updated. An RFC3339 formatted datetime string.
attachedCatalogs string[]
The list of catalogs using the private reverse connection endpoint
catalogPrivateEndpointId string
compartmentId string
Identifier of the compartment this private endpoint belongs to
definedTags {[key: string]: string}
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName string
Mutable name of the Private Reverse Connection Endpoint
dnsZones string[]
List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks GetCatalogPrivateEndpointLock[]
Locks associated with this resource.
state string
The current state of the private endpoint resource.
subnetId string
Subnet Identifier
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 private endpoint was created. An RFC3339 formatted datetime string.
timeUpdated string
The time the private endpoint was updated. An RFC3339 formatted datetime string.
attached_catalogs Sequence[str]
The list of catalogs using the private reverse connection endpoint
catalog_private_endpoint_id str
compartment_id str
Identifier of the compartment this private endpoint belongs to
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
Mutable name of the Private Reverse Connection Endpoint
dns_zones Sequence[str]
List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks Sequence[datacatalog.GetCatalogPrivateEndpointLock]
Locks associated with this resource.
state str
The current state of the private endpoint resource.
subnet_id str
Subnet Identifier
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 private endpoint was created. An RFC3339 formatted datetime string.
time_updated str
The time the private endpoint was updated. An RFC3339 formatted datetime string.
attachedCatalogs List<String>
The list of catalogs using the private reverse connection endpoint
catalogPrivateEndpointId String
compartmentId String
Identifier of the compartment this private endpoint belongs to
definedTags Map<String>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String
Mutable name of the Private Reverse Connection Endpoint
dnsZones List<String>
List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks List<Property Map>
Locks associated with this resource.
state String
The current state of the private endpoint resource.
subnetId String
Subnet Identifier
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 private endpoint was created. An RFC3339 formatted datetime string.
timeUpdated String
The time the private endpoint was updated. An RFC3339 formatted datetime string.

Supporting Types

GetCatalogPrivateEndpointLock

Message This property is required. 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 This property is required. string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated This property is required. string
The time the private endpoint was created. An RFC3339 formatted datetime string.
Type This property is required. string
Type of the lock.
Message This property is required. 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 This property is required. string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated This property is required. string
The time the private endpoint was created. An RFC3339 formatted datetime string.
Type This property is required. string
Type of the lock.
message This property is required. 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 This property is required. String
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated This property is required. String
The time the private endpoint was created. An RFC3339 formatted datetime string.
type This property is required. String
Type of the lock.
message This property is required. 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 This property is required. string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated This property is required. string
The time the private endpoint was created. An RFC3339 formatted datetime string.
type This property is required. string
Type of the lock.
message This property is required. 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 This property is required. str
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created This property is required. str
The time the private endpoint was created. An RFC3339 formatted datetime string.
type This property is required. str
Type of the lock.
message This property is required. 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 This property is required. String
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated This property is required. String
The time the private endpoint was created. An RFC3339 formatted datetime string.
type This property is required. 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.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi