Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GloballyDistributedDatabase
  5. PrivateEndpoint
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GloballyDistributedDatabase.PrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Private Endpoint resource in Oracle Cloud Infrastructure Globally Distributed Database service.

    Creates a PrivateEndpoint.

    Example Usage

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

const testPrivateEndpoint = new oci.globallydistributeddatabase.PrivateEndpoint("test_private_endpoint", {
    compartmentId: compartmentId,
    displayName: privateEndpointDisplayName,
    subnetId: testSubnet.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: privateEndpointDescription,
    freeformTags: {
        "bar-key": "value",
    },
    nsgIds: privateEndpointNsgIds,
});

    import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.globally_distributed_database.PrivateEndpoint("test_private_endpoint",
    compartment_id=compartment_id,
    display_name=private_endpoint_display_name,
    subnet_id=test_subnet["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=private_endpoint_description,
    freeform_tags={
        "bar-key": "value",
    },
    nsg_ids=private_endpoint_nsg_ids)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globallydistributeddatabase.NewPrivateEndpoint(ctx, "test_private_endpoint", &globallydistributeddatabase.PrivateEndpointArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(privateEndpointDisplayName),
			SubnetId:      pulumi.Any(testSubnet.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(privateEndpointDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			NsgIds: pulumi.Any(privateEndpointNsgIds),
		})
		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 testPrivateEndpoint = new Oci.GloballyDistributedDatabase.PrivateEndpoint("test_private_endpoint", new()
    {
        CompartmentId = compartmentId,
        DisplayName = privateEndpointDisplayName,
        SubnetId = testSubnet.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = privateEndpointDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        NsgIds = privateEndpointNsgIds,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GloballyDistributedDatabase.PrivateEndpoint;
import com.pulumi.oci.GloballyDistributedDatabase.PrivateEndpointArgs;
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 testPrivateEndpoint = new PrivateEndpoint("testPrivateEndpoint", PrivateEndpointArgs.builder()
            .compartmentId(compartmentId)
            .displayName(privateEndpointDisplayName)
            .subnetId(testSubnet.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(privateEndpointDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .nsgIds(privateEndpointNsgIds)
            .build());

    }
}

    resources:
  testPrivateEndpoint:
    type: oci:GloballyDistributedDatabase:PrivateEndpoint
    name: test_private_endpoint
    properties:
      compartmentId: ${compartmentId}
      displayName: ${privateEndpointDisplayName}
      subnetId: ${testSubnet.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${privateEndpointDescription}
      freeformTags:
        bar-key: value
      nsgIds: ${privateEndpointNsgIds}

    Create PrivateEndpoint Resource

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

    Constructor syntax

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

@overload
def PrivateEndpoint(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 NewPrivateEndpoint(ctx *Context, name string, args PrivateEndpointArgs, opts ...ResourceOption) (*PrivateEndpoint, error)
    public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public PrivateEndpoint(String name, PrivateEndpointArgs args)
public PrivateEndpoint(String name, PrivateEndpointArgs args, CustomResourceOptions options)

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

    example, err := globallydistributeddatabase.NewPrivateEndpoint(ctx, "exampleprivateEndpointResourceResourceFromGloballyDistributedDatabaseprivateEndpoint", &globallydistributeddatabase.PrivateEndpointArgs{
	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 exampleprivateEndpointResourceResourceFromGloballyDistributedDatabaseprivateEndpoint = new com.pulumi.oci.GloballyDistributedDatabase.PrivateEndpoint("exampleprivateEndpointResourceResourceFromGloballyDistributedDatabaseprivateEndpoint", com.pulumi.oci.GloballyDistributedDatabase.PrivateEndpointArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .subnetId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .nsgIds("string")
    .reinstateProxyInstanceTrigger(0)
    .build());

    exampleprivate_endpoint_resource_resource_from_globally_distributed_databaseprivate_endpoint = oci.globally_distributed_database.PrivateEndpoint("exampleprivateEndpointResourceResourceFromGloballyDistributedDatabaseprivateEndpoint",
    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 exampleprivateEndpointResourceResourceFromGloballyDistributedDatabaseprivateEndpoint = new oci.globallydistributeddatabase.PrivateEndpoint("exampleprivateEndpointResourceResourceFromGloballyDistributedDatabaseprivateEndpoint", {
    compartmentId: "string",
    displayName: "string",
    subnetId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    nsgIds: ["string"],
    reinstateProxyInstanceTrigger: 0,
});

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

    PrivateEndpoint 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 PrivateEndpoint 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) PrivateEndpoint 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) PrivateEndpoint 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) PrivateEndpoint 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) PrivateEndpoint 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) PrivateEndpoint 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) PrivateEndpoint 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 PrivateEndpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleStateDetails string
    Detailed message for the lifecycle state.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    ShardedDatabases List<string>
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleStateDetails string
    Detailed message for the lifecycle state.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    ShardedDatabases []string
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleStateDetails String
    Detailed message for the lifecycle state.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    shardedDatabases List<String>
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleStateDetails string
    Detailed message for the lifecycle state.
    privateIp string
    IP address of the Private Endpoint.
    proxyComputeInstanceId string
    The identifier of the proxy compute instance.
    shardedDatabases string[]
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state_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.
    sharded_databases Sequence[str]
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleStateDetails String
    Detailed message for the lifecycle state.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    shardedDatabases List<String>
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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 PrivateEndpoint Resource

    Get an existing PrivateEndpoint 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?: PrivateEndpointState, opts?: CustomResourceOptions): PrivateEndpoint
    @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,
        lifecycle_state_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,
        sharded_databases: Optional[Sequence[str]] = 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) -> PrivateEndpoint
    func GetPrivateEndpoint(ctx *Context, name string, id IDInput, state *PrivateEndpointState, opts ...ResourceOption) (*PrivateEndpoint, error)
    public static PrivateEndpoint Get(string name, Input<string> id, PrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static PrivateEndpoint get(String name, Output<String> id, PrivateEndpointState state, CustomResourceOptions options)
    resources:  _:    type: oci:GloballyDistributedDatabase:PrivateEndpoint    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) PrivateEndpoint 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"}
    LifecycleStateDetails 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

    ShardedDatabases List<string>
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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) PrivateEndpoint 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"}
    LifecycleStateDetails 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

    ShardedDatabases []string
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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) PrivateEndpoint 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"}
    lifecycleStateDetails 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

    shardedDatabases List<String>
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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) PrivateEndpoint 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"}
    lifecycleStateDetails 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

    shardedDatabases string[]
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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) PrivateEndpoint 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"}
    lifecycle_state_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

    sharded_databases Sequence[str]
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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) PrivateEndpoint 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"}
    lifecycleStateDetails 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

    shardedDatabases List<String>
    The OCIDs of sharded databases that consumes the given private endpoint.
    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 PrivateEndpoint 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.

    Import

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

    $ pulumi import oci:GloballyDistributedDatabase/privateEndpoint:PrivateEndpoint test_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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci