Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. CatalogPrivateEndpoint
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataCatalog.CatalogPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

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

    Create a new private reverse connection endpoint.

    Example Usage

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

const testCatalogPrivateEndpoint = new oci.datacatalog.CatalogPrivateEndpoint("test_catalog_private_endpoint", {
    compartmentId: compartmentId,
    dnsZones: catalogPrivateEndpointDnsZones,
    subnetId: testSubnet.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    displayName: catalogPrivateEndpointDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
});

    import pulumi
import pulumi_oci as oci

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

    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.NewCatalogPrivateEndpoint(ctx, "test_catalog_private_endpoint", &DataCatalog.CatalogPrivateEndpointArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DnsZones:      pulumi.Any(catalogPrivateEndpointDnsZones),
			SubnetId:      pulumi.Any(testSubnet.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			DisplayName: pulumi.Any(catalogPrivateEndpointDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
		})
		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 testCatalogPrivateEndpoint = new Oci.DataCatalog.CatalogPrivateEndpoint("test_catalog_private_endpoint", new()
    {
        CompartmentId = compartmentId,
        DnsZones = catalogPrivateEndpointDnsZones,
        SubnetId = testSubnet.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DisplayName = catalogPrivateEndpointDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});

    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(compartmentId)
            .dnsZones(catalogPrivateEndpointDnsZones)
            .subnetId(testSubnet.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .displayName(catalogPrivateEndpointDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}

    resources:
  testCatalogPrivateEndpoint:
    type: oci:DataCatalog:CatalogPrivateEndpoint
    name: test_catalog_private_endpoint
    properties:
      compartmentId: ${compartmentId}
      dnsZones: ${catalogPrivateEndpointDnsZones}
      subnetId: ${testSubnet.id}
      definedTags:
        foo-namespace.bar-key: value
      displayName: ${catalogPrivateEndpointDisplayName}
      freeformTags:
        bar-key: value

    Create CatalogPrivateEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CatalogPrivateEndpoint(name: string, args: CatalogPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
def CatalogPrivateEndpoint(resource_name: str,
                           args: CatalogPrivateEndpointArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def CatalogPrivateEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           compartment_id: Optional[str] = None,
                           dns_zones: Optional[Sequence[str]] = None,
                           subnet_id: Optional[str] = None,
                           defined_tags: Optional[Mapping[str, str]] = None,
                           display_name: Optional[str] = None,
                           freeform_tags: Optional[Mapping[str, str]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var catalogPrivateEndpointResource = new Oci.DataCatalog.CatalogPrivateEndpoint("catalogPrivateEndpointResource", new()
{
    CompartmentId = "string",
    DnsZones = new[]
    {
        "string",
    },
    SubnetId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := DataCatalog.NewCatalogPrivateEndpoint(ctx, "catalogPrivateEndpointResource", &DataCatalog.CatalogPrivateEndpointArgs{
	CompartmentId: pulumi.String("string"),
	DnsZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	SubnetId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var catalogPrivateEndpointResource = new CatalogPrivateEndpoint("catalogPrivateEndpointResource", CatalogPrivateEndpointArgs.builder()
    .compartmentId("string")
    .dnsZones("string")
    .subnetId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    catalog_private_endpoint_resource = oci.data_catalog.CatalogPrivateEndpoint("catalogPrivateEndpointResource",
    compartment_id="string",
    dns_zones=["string"],
    subnet_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const catalogPrivateEndpointResource = new oci.datacatalog.CatalogPrivateEndpoint("catalogPrivateEndpointResource", {
    compartmentId: "string",
    dnsZones: ["string"],
    subnetId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:DataCatalog:CatalogPrivateEndpoint
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    dnsZones:
        - string
    freeformTags:
        string: string
    subnetId: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (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, string>
    (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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (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]string
    (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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (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,String>
    (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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (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]: string}
    (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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (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, str]
    (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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (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>
    (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.
    Locks List<CatalogPrivateEndpointLock>
    Locks associated with this resource.
    State string
    The current state of the private endpoint resource.
    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
    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.
    Locks []CatalogPrivateEndpointLock
    Locks associated with this resource.
    State string
    The current state of the private endpoint resource.
    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
    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.
    locks List<CatalogPrivateEndpointLock>
    Locks associated with this resource.
    state String
    The current state of the private endpoint resource.
    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
    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.
    locks CatalogPrivateEndpointLock[]
    Locks associated with this resource.
    state string
    The current state of the private endpoint resource.
    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
    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.
    locks Sequence[datacatalog.CatalogPrivateEndpointLock]
    Locks associated with this resource.
    state str
    The current state of the private endpoint resource.
    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
    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.
    locks List<Property Map>
    Locks associated with this resource.
    state String
    The current state of the private endpoint resource.
    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.

    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, str]] = None,
        display_name: Optional[str] = None,
        dns_zones: Optional[Sequence[str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        locks: Optional[Sequence[_datacatalog.CatalogPrivateEndpointLockArgs]] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, 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, string>
    (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, string>
    (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.
    Locks List<CatalogPrivateEndpointLock>
    Locks associated with this resource.
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    CompartmentId string
    (Updatable) Compartment identifier.
    DefinedTags map[string]string
    (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]string
    (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.
    Locks []CatalogPrivateEndpointLockArgs
    Locks associated with this resource.
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    compartmentId String
    (Updatable) Compartment identifier.
    definedTags Map<String,String>
    (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,String>
    (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.
    locks List<CatalogPrivateEndpointLock>
    Locks associated with this resource.
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    compartmentId string
    (Updatable) Compartment identifier.
    definedTags {[key: string]: string}
    (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]: string}
    (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.
    locks CatalogPrivateEndpointLock[]
    Locks associated with this resource.
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    compartment_id str
    (Updatable) Compartment identifier.
    defined_tags Mapping[str, str]
    (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, str]
    (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.
    locks Sequence[datacatalog.CatalogPrivateEndpointLockArgs]
    Locks associated with this resource.
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    compartmentId String
    (Updatable) Compartment identifier.
    definedTags Map<String>
    (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>
    (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.
    locks List<Property Map>
    Locks associated with this resource.
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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

    CatalogPrivateEndpointLock, CatalogPrivateEndpointLockArgs

    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.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated 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.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated 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.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated 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.
    relatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated 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.
    related_resource_id 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.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    The time the private endpoint was created. An RFC3339 formatted datetime string.
    type String
    Type of the lock.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci