Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.3.0 published on Tuesday, Aug 16, 2022 by Pulumi

getCatalogPrivateEndpoints

This data source provides the list of Catalog Private Endpoints in Oracle Cloud Infrastructure Data Catalog service.

Returns a list of all the catalog private endpoints in the specified compartment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testCatalogPrivateEndpoints = Output.Create(Oci.DataCatalog.GetCatalogPrivateEndpoints.InvokeAsync(new Oci.DataCatalog.GetCatalogPrivateEndpointsArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Catalog_private_endpoint_display_name,
            State = @var.Catalog_private_endpoint_state,
        }));
    }

}
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.GetCatalogPrivateEndpoints(ctx, &datacatalog.GetCatalogPrivateEndpointsArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Catalog_private_endpoint_display_name),
			State:         pulumi.StringRef(_var.Catalog_private_endpoint_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_catalog_private_endpoints = oci.DataCatalog.get_catalog_private_endpoints(compartment_id=var["compartment_id"],
    display_name=var["catalog_private_endpoint_display_name"],
    state=var["catalog_private_endpoint_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCatalogPrivateEndpoints = oci.DataCatalog.getCatalogPrivateEndpoints({
    compartmentId: _var.compartment_id,
    displayName: _var.catalog_private_endpoint_display_name,
    state: _var.catalog_private_endpoint_state,
});

Coming soon!

Using getCatalogPrivateEndpoints

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 getCatalogPrivateEndpoints(args: GetCatalogPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetCatalogPrivateEndpointsResult>
function getCatalogPrivateEndpointsOutput(args: GetCatalogPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetCatalogPrivateEndpointsResult>
def get_catalog_private_endpoints(compartment_id: Optional[str] = None,
                                  display_name: Optional[str] = None,
                                  filters: Optional[Sequence[_datacatalog.GetCatalogPrivateEndpointsFilter]] = None,
                                  state: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCatalogPrivateEndpointsResult
def get_catalog_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                  display_name: Optional[pulumi.Input[str]] = None,
                                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datacatalog.GetCatalogPrivateEndpointsFilterArgs]]]] = None,
                                  state: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetCatalogPrivateEndpointsResult]
func GetCatalogPrivateEndpoints(ctx *Context, args *GetCatalogPrivateEndpointsArgs, opts ...InvokeOption) (*GetCatalogPrivateEndpointsResult, error)
func GetCatalogPrivateEndpointsOutput(ctx *Context, args *GetCatalogPrivateEndpointsOutputArgs, opts ...InvokeOption) GetCatalogPrivateEndpointsResultOutput

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

public static class GetCatalogPrivateEndpoints 
{
    public static Task<GetCatalogPrivateEndpointsResult> InvokeAsync(GetCatalogPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogPrivateEndpointsResult> Invoke(GetCatalogPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCatalogPrivateEndpointsResult> getCatalogPrivateEndpoints(GetCatalogPrivateEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataCatalog/getCatalogPrivateEndpoints:getCatalogPrivateEndpoints
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment where you want to list resources.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Filters List<GetCatalogPrivateEndpointsFilter>
State string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

CompartmentId string

The OCID of the compartment where you want to list resources.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Filters []GetCatalogPrivateEndpointsFilter
State string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String

The OCID of the compartment where you want to list resources.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters List<GetCatalogPrivateEndpointsFilter>
state String

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId string

The OCID of the compartment where you want to list resources.

displayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters GetCatalogPrivateEndpointsFilter[]
state string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartment_id str

The OCID of the compartment where you want to list resources.

display_name str

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters GetCatalogPrivateEndpointsFilter]
state str

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String

The OCID of the compartment where you want to list resources.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters List<Property Map>
state String

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getCatalogPrivateEndpoints Result

The following output properties are available:

CatalogPrivateEndpoints List<GetCatalogPrivateEndpointsCatalogPrivateEndpoint>

The list of catalog_private_endpoints.

CompartmentId string

Identifier of the compartment this private endpoint belongs to

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

Mutable name of the Private Reverse Connection Endpoint

Filters List<GetCatalogPrivateEndpointsFilter>
State string

The current state of the private endpoint resource.

CatalogPrivateEndpoints []GetCatalogPrivateEndpointsCatalogPrivateEndpoint

The list of catalog_private_endpoints.

CompartmentId string

Identifier of the compartment this private endpoint belongs to

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

Mutable name of the Private Reverse Connection Endpoint

Filters []GetCatalogPrivateEndpointsFilter
State string

The current state of the private endpoint resource.

catalogPrivateEndpoints List<GetCatalogPrivateEndpointsCatalogPrivateEndpoint>

The list of catalog_private_endpoints.

compartmentId String

Identifier of the compartment this private endpoint belongs to

id String

The provider-assigned unique ID for this managed resource.

displayName String

Mutable name of the Private Reverse Connection Endpoint

filters List<GetCatalogPrivateEndpointsFilter>
state String

The current state of the private endpoint resource.

catalogPrivateEndpoints GetCatalogPrivateEndpointsCatalogPrivateEndpoint[]

The list of catalog_private_endpoints.

compartmentId string

Identifier of the compartment this private endpoint belongs to

id string

The provider-assigned unique ID for this managed resource.

displayName string

Mutable name of the Private Reverse Connection Endpoint

filters GetCatalogPrivateEndpointsFilter[]
state string

The current state of the private endpoint resource.

catalog_private_endpoints GetCatalogPrivateEndpointsCatalogPrivateEndpoint]

The list of catalog_private_endpoints.

compartment_id str

Identifier of the compartment this private endpoint belongs to

id str

The provider-assigned unique ID for this managed resource.

display_name str

Mutable name of the Private Reverse Connection Endpoint

filters GetCatalogPrivateEndpointsFilter]
state str

The current state of the private endpoint resource.

catalogPrivateEndpoints List<Property Map>

The list of catalog_private_endpoints.

compartmentId String

Identifier of the compartment this private endpoint belongs to

id String

The provider-assigned unique ID for this managed resource.

displayName String

Mutable name of the Private Reverse Connection Endpoint

filters List<Property Map>
state String

The current state of the private endpoint resource.

Supporting Types

GetCatalogPrivateEndpointsCatalogPrivateEndpoint

AttachedCatalogs List<string>

The list of catalogs using the private reverse connection endpoint

CompartmentId string

The OCID of the compartment where you want to list resources.

DefinedTags Dictionary<string, object>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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

CompartmentId string

The OCID of the compartment where you want to list resources.

DefinedTags map[string]interface{}

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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

compartmentId String

The OCID of the compartment where you want to list resources.

definedTags Map<String,Object>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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

compartmentId string

The OCID of the compartment where you want to list resources.

definedTags {[key: string]: any}

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

displayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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

compartment_id str

The OCID of the compartment where you want to list resources.

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

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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

compartmentId String

The OCID of the compartment where you want to list resources.

definedTags Map<Any>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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.

GetCatalogPrivateEndpointsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.