1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. DistributedDatabaseDistributedDatabasePrivateEndpoint
Viewing docs for Oracle Cloud Infrastructure v4.5.1
published on Friday, Apr 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpoint

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.5.1
published on Friday, Apr 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This resource provides the Distributed Database Private Endpoint resource in Oracle Cloud Infrastructure Distributed Database service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/globally-distributed-database/latest/DistributedDatabasePrivateEndpoint

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/distributed_database

    Creates a DistributedDatabasePrivateEndpoint.

    Example Usage

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

const testDistributedDatabasePrivateEndpoint = new oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpoint("test_distributed_database_private_endpoint", {
    compartmentId: compartmentId,
    displayName: distributedDatabasePrivateEndpointDisplayName,
    subnetId: testSubnet.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: distributedDatabasePrivateEndpointDescription,
    freeformTags: {
        "bar-key": "value",
    },
    nsgIds: distributedDatabasePrivateEndpointNsgIds,
});

    import pulumi
import pulumi_oci as oci

test_distributed_database_private_endpoint = oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpoint("test_distributed_database_private_endpoint",
    compartment_id=compartment_id,
    display_name=distributed_database_private_endpoint_display_name,
    subnet_id=test_subnet["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=distributed_database_private_endpoint_description,
    freeform_tags={
        "bar-key": "value",
    },
    nsg_ids=distributed_database_private_endpoint_nsg_ids)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/oci"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.NewDistributedDatabaseDistributedDatabasePrivateEndpoint(ctx, "test_distributed_database_private_endpoint", &oci.DistributedDatabaseDistributedDatabasePrivateEndpointArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(distributedDatabasePrivateEndpointDisplayName),
			SubnetId:      pulumi.Any(testSubnet.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(distributedDatabasePrivateEndpointDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			NsgIds: pulumi.Any(distributedDatabasePrivateEndpointNsgIds),
		})
		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 testDistributedDatabasePrivateEndpoint = new Oci.Oci.DistributedDatabaseDistributedDatabasePrivateEndpoint("test_distributed_database_private_endpoint", new()
    {
        CompartmentId = compartmentId,
        DisplayName = distributedDatabasePrivateEndpointDisplayName,
        SubnetId = testSubnet.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = distributedDatabasePrivateEndpointDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        NsgIds = distributedDatabasePrivateEndpointNsgIds,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpoint;
import com.pulumi.oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpointArgs;
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 testDistributedDatabasePrivateEndpoint = new DistributedDatabaseDistributedDatabasePrivateEndpoint("testDistributedDatabasePrivateEndpoint", DistributedDatabaseDistributedDatabasePrivateEndpointArgs.builder()
            .compartmentId(compartmentId)
            .displayName(distributedDatabasePrivateEndpointDisplayName)
            .subnetId(testSubnet.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(distributedDatabasePrivateEndpointDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .nsgIds(distributedDatabasePrivateEndpointNsgIds)
            .build());

    }
}

    resources:
  testDistributedDatabasePrivateEndpoint:
    type: oci:oci:DistributedDatabaseDistributedDatabasePrivateEndpoint
    name: test_distributed_database_private_endpoint
    properties:
      compartmentId: ${compartmentId}
      displayName: ${distributedDatabasePrivateEndpointDisplayName}
      subnetId: ${testSubnet.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${distributedDatabasePrivateEndpointDescription}
      freeformTags:
        bar-key: value
      nsgIds: ${distributedDatabasePrivateEndpointNsgIds}

    Create DistributedDatabaseDistributedDatabasePrivateEndpoint Resource

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

    Constructor syntax

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

@overload
def DistributedDatabaseDistributedDatabasePrivateEndpoint(resource_name: str,
                                                          opts: Optional[ResourceOptions] = None,
                                                          compartment_id: Optional[str] = None,
                                                          display_name: Optional[str] = None,
                                                          subnet_id: Optional[str] = None,
                                                          defined_tags: Optional[Mapping[str, str]] = None,
                                                          description: Optional[str] = None,
                                                          freeform_tags: Optional[Mapping[str, str]] = None,
                                                          nsg_ids: Optional[Sequence[str]] = None,
                                                          reinstate_proxy_instance_trigger: Optional[int] = None)
    func NewDistributedDatabaseDistributedDatabasePrivateEndpoint(ctx *Context, name string, args DistributedDatabaseDistributedDatabasePrivateEndpointArgs, opts ...ResourceOption) (*DistributedDatabaseDistributedDatabasePrivateEndpoint, error)
    public DistributedDatabaseDistributedDatabasePrivateEndpoint(string name, DistributedDatabaseDistributedDatabasePrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public DistributedDatabaseDistributedDatabasePrivateEndpoint(String name, DistributedDatabaseDistributedDatabasePrivateEndpointArgs args)
public DistributedDatabaseDistributedDatabasePrivateEndpoint(String name, DistributedDatabaseDistributedDatabasePrivateEndpointArgs args, CustomResourceOptions options)

    type: oci:oci:DistributedDatabaseDistributedDatabasePrivateEndpoint
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 DistributedDatabaseDistributedDatabasePrivateEndpointArgs
    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 DistributedDatabaseDistributedDatabasePrivateEndpointArgs
    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 DistributedDatabaseDistributedDatabasePrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DistributedDatabaseDistributedDatabasePrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DistributedDatabaseDistributedDatabasePrivateEndpointArgs
    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 distributedDatabaseDistributedDatabasePrivateEndpointResource = new Oci.Oci.DistributedDatabaseDistributedDatabasePrivateEndpoint("distributedDatabaseDistributedDatabasePrivateEndpointResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    SubnetId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    NsgIds = new[]
    {
        "string",
    },
    ReinstateProxyInstanceTrigger = 0,
});

    example, err := oci.NewDistributedDatabaseDistributedDatabasePrivateEndpoint(ctx, "distributedDatabaseDistributedDatabasePrivateEndpointResource", &oci.DistributedDatabaseDistributedDatabasePrivateEndpointArgs{
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	SubnetId:      pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReinstateProxyInstanceTrigger: pulumi.Int(0),
})

    var distributedDatabaseDistributedDatabasePrivateEndpointResource = new DistributedDatabaseDistributedDatabasePrivateEndpoint("distributedDatabaseDistributedDatabasePrivateEndpointResource", DistributedDatabaseDistributedDatabasePrivateEndpointArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .subnetId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .nsgIds("string")
    .reinstateProxyInstanceTrigger(0)
    .build());

    distributed_database_distributed_database_private_endpoint_resource = oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpoint("distributedDatabaseDistributedDatabasePrivateEndpointResource",
    compartment_id="string",
    display_name="string",
    subnet_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    nsg_ids=["string"],
    reinstate_proxy_instance_trigger=0)

    const distributedDatabaseDistributedDatabasePrivateEndpointResource = new oci.oci.DistributedDatabaseDistributedDatabasePrivateEndpoint("distributedDatabaseDistributedDatabasePrivateEndpointResource", {
    compartmentId: "string",
    displayName: "string",
    subnetId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    nsgIds: ["string"],
    reinstateProxyInstanceTrigger: 0,
});

    type: oci:oci:DistributedDatabaseDistributedDatabasePrivateEndpoint
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    nsgIds:
        - string
    reinstateProxyInstanceTrigger: 0
    subnetId: string

    DistributedDatabaseDistributedDatabasePrivateEndpoint 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 DistributedDatabaseDistributedDatabasePrivateEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    DisplayName string
    (Updatable) Private endpoint display name.
    SubnetId string
    Identifier of the customer subnet against which private endpoint is to be created.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) DistributedDatabasePrivateEndpoint description.
    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"}
    NsgIds List<string>
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    ReinstateProxyInstanceTrigger int

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    CompartmentId string
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    DisplayName string
    (Updatable) Private endpoint display name.
    SubnetId string
    Identifier of the customer subnet against which private endpoint is to be created.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) DistributedDatabasePrivateEndpoint description.
    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"}
    NsgIds []string
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    ReinstateProxyInstanceTrigger int

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    compartmentId String
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    displayName String
    (Updatable) Private endpoint display name.
    subnetId String
    Identifier of the customer subnet against which private endpoint is to be created.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) DistributedDatabasePrivateEndpoint description.
    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"}
    nsgIds List<String>
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    reinstateProxyInstanceTrigger Integer

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    compartmentId string
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    displayName string
    (Updatable) Private endpoint display name.
    subnetId string
    Identifier of the customer subnet against which private endpoint is to be created.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) DistributedDatabasePrivateEndpoint description.
    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"}
    nsgIds string[]
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    reinstateProxyInstanceTrigger number

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    compartment_id str
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    display_name str
    (Updatable) Private endpoint display name.
    subnet_id str
    Identifier of the customer subnet against which private endpoint is to be created.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) DistributedDatabasePrivateEndpoint description.
    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"}
    nsg_ids Sequence[str]
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    reinstate_proxy_instance_trigger int

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    compartmentId String
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    displayName String
    (Updatable) Private endpoint display name.
    subnetId String
    Identifier of the customer subnet against which private endpoint is to be created.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) DistributedDatabasePrivateEndpoint description.
    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"}
    nsgIds List<String>
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    reinstateProxyInstanceTrigger Number

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    Outputs

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

    GloballyDistributedAutonomousDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase>
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    GloballyDistributedDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase>
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    State string
    Lifecycle states for private endpoint.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    VcnId string
    Identifier of the VCN in which subnet exists.
    GloballyDistributedAutonomousDatabases []DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    GloballyDistributedDatabases []DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    State string
    Lifecycle states for private endpoint.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    VcnId string
    Identifier of the VCN in which subnet exists.
    globallyDistributedAutonomousDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase>
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globallyDistributedDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase>
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    state String
    Lifecycle states for private endpoint.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId String
    Identifier of the VCN in which subnet exists.
    globallyDistributedAutonomousDatabases DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase[]
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globallyDistributedDatabases DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase[]
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Detailed message for the lifecycle state.
    privateIp string
    IP address of the Private Endpoint.
    proxyComputeInstanceId string
    The identifier of the proxy compute instance.
    state string
    Lifecycle states for private endpoint.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId string
    Identifier of the VCN in which subnet exists.
    globally_distributed_autonomous_databases Sequence[DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase]
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globally_distributed_databases Sequence[DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase]
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Detailed message for the lifecycle state.
    private_ip str
    IP address of the Private Endpoint.
    proxy_compute_instance_id str
    The identifier of the proxy compute instance.
    state str
    Lifecycle states for private endpoint.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    time_updated str
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcn_id str
    Identifier of the VCN in which subnet exists.
    globallyDistributedAutonomousDatabases List<Property Map>
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globallyDistributedDatabases List<Property Map>
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    state String
    Lifecycle states for private endpoint.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId String
    Identifier of the VCN in which subnet exists.

    Look up Existing DistributedDatabaseDistributedDatabasePrivateEndpoint Resource

    Get an existing DistributedDatabaseDistributedDatabasePrivateEndpoint 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?: DistributedDatabaseDistributedDatabasePrivateEndpointState, opts?: CustomResourceOptions): DistributedDatabaseDistributedDatabasePrivateEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        globally_distributed_autonomous_databases: Optional[Sequence[DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabaseArgs]] = None,
        globally_distributed_databases: Optional[Sequence[DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabaseArgs]] = None,
        lifecycle_details: Optional[str] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        private_ip: Optional[str] = None,
        proxy_compute_instance_id: Optional[str] = None,
        reinstate_proxy_instance_trigger: Optional[int] = 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,
        vcn_id: Optional[str] = None) -> DistributedDatabaseDistributedDatabasePrivateEndpoint
    func GetDistributedDatabaseDistributedDatabasePrivateEndpoint(ctx *Context, name string, id IDInput, state *DistributedDatabaseDistributedDatabasePrivateEndpointState, opts ...ResourceOption) (*DistributedDatabaseDistributedDatabasePrivateEndpoint, error)
    public static DistributedDatabaseDistributedDatabasePrivateEndpoint Get(string name, Input<string> id, DistributedDatabaseDistributedDatabasePrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static DistributedDatabaseDistributedDatabasePrivateEndpoint get(String name, Output<String> id, DistributedDatabaseDistributedDatabasePrivateEndpointState state, CustomResourceOptions options)
    resources:  _:    type: oci:oci:DistributedDatabaseDistributedDatabasePrivateEndpoint    get:      id: ${id}
    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:
    CompartmentId string
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) DistributedDatabasePrivateEndpoint description.
    DisplayName string
    (Updatable) Private endpoint display name.
    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"}
    GloballyDistributedAutonomousDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase>
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    GloballyDistributedDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase>
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    NsgIds List<string>
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    ReinstateProxyInstanceTrigger int

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    State string
    Lifecycle states for private endpoint.
    SubnetId string
    Identifier of the customer subnet against which private endpoint is to be created.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    VcnId string
    Identifier of the VCN in which subnet exists.
    CompartmentId string
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) DistributedDatabasePrivateEndpoint description.
    DisplayName string
    (Updatable) Private endpoint display name.
    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"}
    GloballyDistributedAutonomousDatabases []DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabaseArgs
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    GloballyDistributedDatabases []DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabaseArgs
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    NsgIds []string
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    ReinstateProxyInstanceTrigger int

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    State string
    Lifecycle states for private endpoint.
    SubnetId string
    Identifier of the customer subnet against which private endpoint is to be created.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    VcnId string
    Identifier of the VCN in which subnet exists.
    compartmentId String
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) DistributedDatabasePrivateEndpoint description.
    displayName String
    (Updatable) Private endpoint display name.
    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"}
    globallyDistributedAutonomousDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase>
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globallyDistributedDatabases List<DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase>
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    nsgIds List<String>
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    reinstateProxyInstanceTrigger Integer

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    state String
    Lifecycle states for private endpoint.
    subnetId String
    Identifier of the customer subnet against which private endpoint is to be created.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId String
    Identifier of the VCN in which subnet exists.
    compartmentId string
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) DistributedDatabasePrivateEndpoint description.
    displayName string
    (Updatable) Private endpoint display name.
    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"}
    globallyDistributedAutonomousDatabases DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase[]
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globallyDistributedDatabases DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase[]
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    lifecycleDetails string
    Detailed message for the lifecycle state.
    nsgIds string[]
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    privateIp string
    IP address of the Private Endpoint.
    proxyComputeInstanceId string
    The identifier of the proxy compute instance.
    reinstateProxyInstanceTrigger number

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    state string
    Lifecycle states for private endpoint.
    subnetId string
    Identifier of the customer subnet against which private endpoint is to be created.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId string
    Identifier of the VCN in which subnet exists.
    compartment_id str
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) DistributedDatabasePrivateEndpoint description.
    display_name str
    (Updatable) Private endpoint display name.
    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"}
    globally_distributed_autonomous_databases Sequence[DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabaseArgs]
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globally_distributed_databases Sequence[DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabaseArgs]
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    lifecycle_details str
    Detailed message for the lifecycle state.
    nsg_ids Sequence[str]
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    private_ip str
    IP address of the Private Endpoint.
    proxy_compute_instance_id str
    The identifier of the proxy compute instance.
    reinstate_proxy_instance_trigger int

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    state str
    Lifecycle states for private endpoint.
    subnet_id str
    Identifier of the customer subnet against which private endpoint is to be created.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    time_updated str
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcn_id str
    Identifier of the VCN in which subnet exists.
    compartmentId String
    (Updatable) Identifier of the compartment where private endpoint is to be created.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) DistributedDatabasePrivateEndpoint description.
    displayName String
    (Updatable) Private endpoint display name.
    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"}
    globallyDistributedAutonomousDatabases List<Property Map>
    The details of the non-deleted Globally distributed autonomous databases that consumes the given private endpoint.
    globallyDistributedDatabases List<Property Map>
    The details of the non-deleted Globally distributed databases that consumes the given private endpoint.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    nsgIds List<String>
    (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    reinstateProxyInstanceTrigger Number

    (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.

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

    state String
    Lifecycle states for private endpoint.
    subnetId String
    Identifier of the customer subnet against which private endpoint is to be created.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId String
    Identifier of the VCN in which subnet exists.

    Supporting Types

    DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase, DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabaseArgs

    DbDeploymentType string
    The dbDeploymentType associated with the distributed database.
    Id string
    The identifier of the Private Endpoint.
    DbDeploymentType string
    The dbDeploymentType associated with the distributed database.
    Id string
    The identifier of the Private Endpoint.
    dbDeploymentType String
    The dbDeploymentType associated with the distributed database.
    id String
    The identifier of the Private Endpoint.
    dbDeploymentType string
    The dbDeploymentType associated with the distributed database.
    id string
    The identifier of the Private Endpoint.
    db_deployment_type str
    The dbDeploymentType associated with the distributed database.
    id str
    The identifier of the Private Endpoint.
    dbDeploymentType String
    The dbDeploymentType associated with the distributed database.
    id String
    The identifier of the Private Endpoint.

    DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase, DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabaseArgs

    DbDeploymentType string
    The dbDeploymentType associated with the distributed database.
    Id string
    The identifier of the Private Endpoint.
    DbDeploymentType string
    The dbDeploymentType associated with the distributed database.
    Id string
    The identifier of the Private Endpoint.
    dbDeploymentType String
    The dbDeploymentType associated with the distributed database.
    id String
    The identifier of the Private Endpoint.
    dbDeploymentType string
    The dbDeploymentType associated with the distributed database.
    id string
    The identifier of the Private Endpoint.
    db_deployment_type str
    The dbDeploymentType associated with the distributed database.
    id str
    The identifier of the Private Endpoint.
    dbDeploymentType String
    The dbDeploymentType associated with the distributed database.
    id String
    The identifier of the Private Endpoint.

    Import

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

    $ pulumi import oci:oci/distributedDatabaseDistributedDatabasePrivateEndpoint:DistributedDatabaseDistributedDatabasePrivateEndpoint test_distributed_database_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
    Viewing docs for Oracle Cloud Infrastructure v4.5.1
    published on Friday, Apr 3, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.