Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DataCatalog.CatalogPrivateEndpoint

This resource provides the Catalog Private Endpoint resource in Oracle Cloud Infrastructure Data Catalog service.

Create a new private reverse connection endpoint.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCatalogPrivateEndpoint = new Oci.DataCatalog.CatalogPrivateEndpoint("testCatalogPrivateEndpoint", new()
    {
        CompartmentId = @var.Compartment_id,
        DnsZones = @var.Catalog_private_endpoint_dns_zones,
        SubnetId = oci_core_subnet.Test_subnet.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DisplayName = @var.Catalog_private_endpoint_display_name,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});

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.NewCatalogPrivateEndpoint(ctx, "testCatalogPrivateEndpoint", &DataCatalog.CatalogPrivateEndpointArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DnsZones:      pulumi.Any(_var.Catalog_private_endpoint_dns_zones),
			SubnetId:      pulumi.Any(oci_core_subnet.Test_subnet.Id),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			DisplayName: pulumi.Any(_var.Catalog_private_endpoint_display_name),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
		})
		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.CatalogPrivateEndpoint;
import com.pulumi.oci.DataCatalog.CatalogPrivateEndpointArgs;
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) {
        var testCatalogPrivateEndpoint = new CatalogPrivateEndpoint("testCatalogPrivateEndpoint", CatalogPrivateEndpointArgs.builder()        
            .compartmentId(var_.compartment_id())
            .dnsZones(var_.catalog_private_endpoint_dns_zones())
            .subnetId(oci_core_subnet.test_subnet().id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .displayName(var_.catalog_private_endpoint_display_name())
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_catalog_private_endpoint = oci.data_catalog.CatalogPrivateEndpoint("testCatalogPrivateEndpoint",
    compartment_id=var["compartment_id"],
    dns_zones=var["catalog_private_endpoint_dns_zones"],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    display_name=var["catalog_private_endpoint_display_name"],
    freeform_tags={
        "bar-key": "value",
    })

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

const testCatalogPrivateEndpoint = new oci.datacatalog.CatalogPrivateEndpoint("testCatalogPrivateEndpoint", {
    compartmentId: _var.compartment_id,
    dnsZones: _var.catalog_private_endpoint_dns_zones,
    subnetId: oci_core_subnet.test_subnet.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    displayName: _var.catalog_private_endpoint_display_name,
    freeformTags: {
        "bar-key": "value",
    },
});

resources:
  testCatalogPrivateEndpoint:
    type: oci:DataCatalog:CatalogPrivateEndpoint
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      dnsZones: ${var.catalog_private_endpoint_dns_zones}
      subnetId: ${oci_core_subnet.test_subnet.id}
      #Optional
      definedTags:
        foo-namespace.bar-key: value
      displayName: ${var.catalog_private_endpoint_display_name}
      freeformTags:
        bar-key: value

Create CatalogPrivateEndpoint Resource

new CatalogPrivateEndpoint(name: string, args: CatalogPrivateEndpointArgs, opts?: CustomResourceOptions);

@overload
def CatalogPrivateEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           compartment_id: Optional[str] = None,
                           defined_tags: Optional[Mapping[str, Any]] = None,
                           display_name: Optional[str] = None,
                           dns_zones: Optional[Sequence[str]] = None,
                           freeform_tags: Optional[Mapping[str, Any]] = None,
                           subnet_id: Optional[str] = None)
@overload
def CatalogPrivateEndpoint(resource_name: str,
                           args: CatalogPrivateEndpointArgs,
                           opts: Optional[ResourceOptions] = None)

func NewCatalogPrivateEndpoint(ctx *Context, name string, args CatalogPrivateEndpointArgs, opts ...ResourceOption) (*CatalogPrivateEndpoint, error)

public CatalogPrivateEndpoint(string name, CatalogPrivateEndpointArgs args, CustomResourceOptions? opts = null)

public CatalogPrivateEndpoint(String name, CatalogPrivateEndpointArgs args)
public CatalogPrivateEndpoint(String name, CatalogPrivateEndpointArgs args, CustomResourceOptions options)

type: oci:DataCatalog:CatalogPrivateEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CatalogPrivateEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CatalogPrivateEndpointArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CatalogPrivateEndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CatalogPrivateEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CatalogPrivateEndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

CatalogPrivateEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CatalogPrivateEndpoint resource accepts the following input properties:

CompartmentId string: (Updatable) Compartment identifier.
DnsZones List<string>: (Updatable) 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
SubnetId string: The OCID of subnet to which the reverse connection is to be created
DefinedTags Dictionary<string, object>: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) Display name of the private endpoint resource being created.
FreeformTags Dictionary<string, object>: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

CompartmentId string: (Updatable) Compartment identifier.
DnsZones []string: (Updatable) 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
SubnetId string: The OCID of subnet to which the reverse connection is to be created
DefinedTags map[string]interface{}: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) Display name of the private endpoint resource being created.
FreeformTags map[string]interface{}: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

compartmentId String: (Updatable) Compartment identifier.
dnsZones List<String>: (Updatable) 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
subnetId String: The OCID of subnet to which the reverse connection is to be created
definedTags Map<String,Object>: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) Display name of the private endpoint resource being created.
freeformTags Map<String,Object>: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

compartmentId string: (Updatable) Compartment identifier.
dnsZones string[]: (Updatable) 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
subnetId string: The OCID of subnet to which the reverse connection is to be created
definedTags {[key: string]: any}: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName string: (Updatable) Display name of the private endpoint resource being created.
freeformTags {[key: string]: any}: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

compartment_id str: (Updatable) Compartment identifier.
dns_zones Sequence[str]: (Updatable) 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
subnet_id str: The OCID of subnet to which the reverse connection is to be created
defined_tags Mapping[str, Any]: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
display_name str: (Updatable) Display name of the private endpoint resource being created.
freeform_tags Mapping[str, Any]: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

compartmentId String: (Updatable) Compartment identifier.
dnsZones List<String>: (Updatable) 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
subnetId String: The OCID of subnet to which the reverse connection is to be created
definedTags Map<Any>: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) Display name of the private endpoint resource being created.
freeformTags Map<Any>: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Outputs

All input properties are implicitly available as output properties. Additionally, the CatalogPrivateEndpoint resource produces the following output properties:

AttachedCatalogs List<string>: The list of catalogs using the private reverse connection endpoint
Id string: The provider-assigned unique ID for this managed resource.
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.
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
Id string: The provider-assigned unique ID for this managed resource.
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.
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
id String: The provider-assigned unique ID for this managed resource.
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.
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
id string: The provider-assigned unique ID for this managed resource.
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.
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
id str: The provider-assigned unique ID for this managed resource.
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.
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
id String: The provider-assigned unique ID for this managed resource.
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.
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.

Look up Existing CatalogPrivateEndpoint Resource

Get an existing CatalogPrivateEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CatalogPrivateEndpointState, opts?: CustomResourceOptions): CatalogPrivateEndpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attached_catalogs: Optional[Sequence[str]] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        dns_zones: Optional[Sequence[str]] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> CatalogPrivateEndpoint

func GetCatalogPrivateEndpoint(ctx *Context, name string, id IDInput, state *CatalogPrivateEndpointState, opts ...ResourceOption) (*CatalogPrivateEndpoint, error)

public static CatalogPrivateEndpoint Get(string name, Input<string> id, CatalogPrivateEndpointState? state, CustomResourceOptions? opts = null)

public static CatalogPrivateEndpoint get(String name, Output<String> id, CatalogPrivateEndpointState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AttachedCatalogs List<string>: The list of catalogs using the private reverse connection endpoint
CompartmentId string: (Updatable) Compartment identifier.
DefinedTags Dictionary<string, object>: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) Display name of the private endpoint resource being created.
DnsZones List<string>: (Updatable) 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>: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: The OCID of subnet to which the reverse connection is to be created
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: (Updatable) Compartment identifier.
DefinedTags map[string]interface{}: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) Display name of the private endpoint resource being created.
DnsZones []string: (Updatable) 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{}: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: The OCID of subnet to which the reverse connection is to be created
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: (Updatable) Compartment identifier.
definedTags Map<String,Object>: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) Display name of the private endpoint resource being created.
dnsZones List<String>: (Updatable) 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>: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: The OCID of subnet to which the reverse connection is to be created
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: (Updatable) Compartment identifier.
definedTags {[key: string]: any}: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName string: (Updatable) Display name of the private endpoint resource being created.
dnsZones string[]: (Updatable) 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}: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: The OCID of subnet to which the reverse connection is to be created
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: (Updatable) Compartment identifier.
defined_tags Mapping[str, Any]: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
display_name str: (Updatable) Display name of the private endpoint resource being created.
dns_zones Sequence[str]: (Updatable) 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]: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: The OCID of subnet to which the reverse connection is to be created
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: (Updatable) Compartment identifier.
definedTags Map<Any>: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) Display name of the private endpoint resource being created.
dnsZones List<String>: (Updatable) 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>: (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: The OCID of subnet to which the reverse connection is to be created
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.

Import

CatalogPrivateEndpoints can be imported using the id, e.g.

 $ pulumi import oci:DataCatalog/catalogPrivateEndpoint:CatalogPrivateEndpoint test_catalog_private_endpoint "id"

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.