Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi
oci.DataCatalog.getCatalogPrivateEndpoints
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testCatalogPrivateEndpoints = oci.DataCatalog.getCatalogPrivateEndpoints({
compartmentId: compartmentId,
displayName: catalogPrivateEndpointDisplayName,
state: catalogPrivateEndpointState,
});
import pulumi
import pulumi_oci as oci
test_catalog_private_endpoints = oci.DataCatalog.get_catalog_private_endpoints(compartment_id=compartment_id,
display_name=catalog_private_endpoint_display_name,
state=catalog_private_endpoint_state)
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.GetCatalogPrivateEndpoints(ctx, &datacatalog.GetCatalogPrivateEndpointsArgs{
CompartmentId: compartmentId,
DisplayName: pulumi.StringRef(catalogPrivateEndpointDisplayName),
State: pulumi.StringRef(catalogPrivateEndpointState),
}, 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 testCatalogPrivateEndpoints = Oci.DataCatalog.GetCatalogPrivateEndpoints.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = catalogPrivateEndpointDisplayName,
State = catalogPrivateEndpointState,
});
});
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.GetCatalogPrivateEndpointsArgs;
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 testCatalogPrivateEndpoints = DataCatalogFunctions.getCatalogPrivateEndpoints(GetCatalogPrivateEndpointsArgs.builder()
.compartmentId(compartmentId)
.displayName(catalogPrivateEndpointDisplayName)
.state(catalogPrivateEndpointState)
.build());
}
}
variables:
testCatalogPrivateEndpoints:
fn::invoke:
function: oci:DataCatalog:getCatalogPrivateEndpoints
arguments:
compartmentId: ${compartmentId}
displayName: ${catalogPrivateEndpointDisplayName}
state: ${catalogPrivateEndpointState}
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:
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
List<Get
Catalog Private Endpoints Filter> - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
[]Get
Catalog Private Endpoints Filter - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String - The OCID of the compartment where you want to list resources.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
List<Get
Catalog Private Endpoints Filter> - state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id string - The OCID of the compartment where you want to list resources.
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
Get
Catalog Private Endpoints Filter[] - 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
Sequence[datacatalog.
Get Catalog Private Endpoints Filter] - state str
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String - The OCID of the compartment where you want to list resources.
- display
Name 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:
- Catalog
Private List<GetEndpoints Catalog Private Endpoints Catalog Private Endpoint> - The list of catalog_private_endpoints.
- Compartment
Id string - Identifier of the compartment this private endpoint belongs to
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - Mutable name of the Private Reverse Connection Endpoint
- Filters
List<Get
Catalog Private Endpoints Filter> - State string
- The current state of the private endpoint resource.
- Catalog
Private []GetEndpoints Catalog Private Endpoints Catalog Private Endpoint - The list of catalog_private_endpoints.
- Compartment
Id string - Identifier of the compartment this private endpoint belongs to
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - Mutable name of the Private Reverse Connection Endpoint
- Filters
[]Get
Catalog Private Endpoints Filter - State string
- The current state of the private endpoint resource.
- catalog
Private List<GetEndpoints Catalog Private Endpoints Catalog Private Endpoint> - The list of catalog_private_endpoints.
- compartment
Id String - Identifier of the compartment this private endpoint belongs to
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - Mutable name of the Private Reverse Connection Endpoint
- filters
List<Get
Catalog Private Endpoints Filter> - state String
- The current state of the private endpoint resource.
- catalog
Private GetEndpoints Catalog Private Endpoints Catalog Private Endpoint[] - The list of catalog_private_endpoints.
- compartment
Id string - Identifier of the compartment this private endpoint belongs to
- id string
- The provider-assigned unique ID for this managed resource.
- display
Name string - Mutable name of the Private Reverse Connection Endpoint
- filters
Get
Catalog Private Endpoints Filter[] - state string
- The current state of the private endpoint resource.
- catalog_
private_ Sequence[datacatalog.endpoints Get Catalog Private Endpoints Catalog Private Endpoint] - 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
Sequence[datacatalog.
Get Catalog Private Endpoints Filter] - state str
- The current state of the private endpoint resource.
- catalog
Private List<Property Map>Endpoints - The list of catalog_private_endpoints.
- compartment
Id String - Identifier of the compartment this private endpoint belongs to
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name 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
- Attached
Catalogs List<string> - The list of catalogs using the private reverse connection endpoint
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- Dictionary<string, string>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Dns
Zones 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
- 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
- Lifecycle
Details 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<Get
Catalog Private Endpoints Catalog Private Endpoint Lock> - Locks associated with this resource.
- State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Subnet
Id string - Subnet Identifier
- 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"}
- Time
Created string - The time the private endpoint was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the private endpoint was updated. An RFC3339 formatted datetime string.
- Attached
Catalogs []string - The list of catalogs using the private reverse connection endpoint
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- map[string]string
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Dns
Zones []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
- 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
- Lifecycle
Details 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
[]Get
Catalog Private Endpoints Catalog Private Endpoint Lock - Locks associated with this resource.
- State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Subnet
Id string - Subnet Identifier
- 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"}
- Time
Created string - The time the private endpoint was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the private endpoint was updated. An RFC3339 formatted datetime string.
- attached
Catalogs List<String> - The list of catalogs using the private reverse connection endpoint
- compartment
Id String - The OCID of the compartment where you want to list resources.
- Map<String,String>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- dns
Zones 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
- 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
- lifecycle
Details 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<Get
Catalog Private Endpoints Catalog Private Endpoint Lock> - Locks associated with this resource.
- state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- subnet
Id String - Subnet Identifier
- 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"}
- time
Created String - The time the private endpoint was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the private endpoint was updated. An RFC3339 formatted datetime string.
- attached
Catalogs string[] - The list of catalogs using the private reverse connection endpoint
- compartment
Id string - The OCID of the compartment where you want to list resources.
- {[key: string]: string}
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- dns
Zones 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
- {[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
- lifecycle
Details 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
Get
Catalog Private Endpoints Catalog Private Endpoint Lock[] - Locks associated with this resource.
- state string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- subnet
Id string - Subnet Identifier
- {[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"}
- time
Created string - The time the private endpoint was created. An RFC3339 formatted datetime string.
- time
Updated 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.
- Mapping[str, str]
- 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
- 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.
Get Catalog Private Endpoints Catalog Private Endpoint Lock] - Locks associated with this resource.
- state str
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- subnet_
id str - Subnet Identifier
- 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.
- attached
Catalogs List<String> - The list of catalogs using the private reverse connection endpoint
- compartment
Id String - The OCID of the compartment where you want to list resources.
- Map<String>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- dns
Zones 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
- 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
- lifecycle
Details 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
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- subnet
Id String - Subnet Identifier
- 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"}
- time
Created String - The time the private endpoint was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the private endpoint was updated. An RFC3339 formatted datetime string.
GetCatalogPrivateEndpointsCatalogPrivateEndpointLock
- 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.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created string - The time the private endpoint 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.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created string - The time the private endpoint 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.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the private endpoint 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.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created string - The time the private endpoint 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.
- 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 private endpoint 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.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the private endpoint was created. An RFC3339 formatted datetime string.
- type String
- Type of the lock.
GetCatalogPrivateEndpointsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.