1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. getCatalogPrivateEndpoint
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

oci.DataCatalog.getCatalogPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 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

    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 = oci_datacatalog_catalog_private_endpoint.Test_catalog_private_endpoint.Id,
        });
    
    });
    
    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.GetCatalogPrivateEndpoint(ctx, &datacatalog.GetCatalogPrivateEndpointArgs{
    			CatalogPrivateEndpointId: oci_datacatalog_catalog_private_endpoint.Test_catalog_private_endpoint.Id,
    		}, nil)
    		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.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(oci_datacatalog_catalog_private_endpoint.test_catalog_private_endpoint().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_catalog_private_endpoint = oci.DataCatalog.get_catalog_private_endpoint(catalog_private_endpoint_id=oci_datacatalog_catalog_private_endpoint["test_catalog_private_endpoint"]["id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testCatalogPrivateEndpoint = oci.DataCatalog.getCatalogPrivateEndpoint({
        catalogPrivateEndpointId: oci_datacatalog_catalog_private_endpoint.test_catalog_private_endpoint.id,
    });
    
    variables:
      testCatalogPrivateEndpoint:
        fn::invoke:
          Function: oci:DataCatalog:getCatalogPrivateEndpoint
          Arguments:
            catalogPrivateEndpointId: ${oci_datacatalog_catalog_private_endpoint.test_catalog_private_endpoint.id}
    

    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>
    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]
    func GetCatalogPrivateEndpoint(ctx *Context, args *GetCatalogPrivateEndpointArgs, opts ...InvokeOption) (*GetCatalogPrivateEndpointResult, error)
    func GetCatalogPrivateEndpointOutput(ctx *Context, args *GetCatalogPrivateEndpointOutputArgs, opts ...InvokeOption) GetCatalogPrivateEndpointResultOutput

    > 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)
    }
    public static CompletableFuture<GetCatalogPrivateEndpointResult> getCatalogPrivateEndpoint(GetCatalogPrivateEndpointArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataCatalog/getCatalogPrivateEndpoint:getCatalogPrivateEndpoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CatalogPrivateEndpointId string

    Unique private reverse connection identifier.

    CatalogPrivateEndpointId string

    Unique private reverse connection identifier.

    catalogPrivateEndpointId String

    Unique private reverse connection identifier.

    catalogPrivateEndpointId string

    Unique private reverse connection identifier.

    catalog_private_endpoint_id str

    Unique private reverse connection identifier.

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

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

    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.

    State string

    The current state of the private endpoint resource.

    SubnetId string

    Subnet Identifier

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

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

    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.

    State string

    The current state of the private endpoint resource.

    SubnetId string

    Subnet Identifier

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

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

    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.

    state String

    The current state of the private endpoint resource.

    subnetId String

    Subnet Identifier

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

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

    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.

    state string

    The current state of the private endpoint resource.

    subnetId string

    Subnet Identifier

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

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

    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.

    state str

    The current state of the private endpoint resource.

    subnet_id str

    Subnet Identifier

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

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

    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.

    state String

    The current state of the private endpoint resource.

    subnetId String

    Subnet Identifier

    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.

    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 v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi