oci.GloballyDistributedDatabase.getPrivateEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testPrivateEndpoint = oci.GloballyDistributedDatabase.getPrivateEndpoint({
    privateEndpointId: testPrivateEndpointOciGloballyDistributedDatabasePrivateEndpoint.id,
});

import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.GloballyDistributedDatabase.get_private_endpoint(private_endpoint_id=test_private_endpoint_oci_globally_distributed_database_private_endpoint["id"])

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.GetPrivateEndpoint(ctx, &globallydistributeddatabase.GetPrivateEndpointArgs{
			PrivateEndpointId: testPrivateEndpointOciGloballyDistributedDatabasePrivateEndpoint.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPrivateEndpoint = Oci.GloballyDistributedDatabase.GetPrivateEndpoint.Invoke(new()
    {
        PrivateEndpointId = testPrivateEndpointOciGloballyDistributedDatabasePrivateEndpoint.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GloballyDistributedDatabase.GloballyDistributedDatabaseFunctions;
import com.pulumi.oci.GloballyDistributedDatabase.inputs.GetPrivateEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testPrivateEndpoint = GloballyDistributedDatabaseFunctions.getPrivateEndpoint(GetPrivateEndpointArgs.builder()
            .privateEndpointId(testPrivateEndpointOciGloballyDistributedDatabasePrivateEndpoint.id())
            .build());

    }
}

variables:
  testPrivateEndpoint:
    fn::invoke:
      function: oci:GloballyDistributedDatabase:getPrivateEndpoint
      arguments:
        privateEndpointId: ${testPrivateEndpointOciGloballyDistributedDatabasePrivateEndpoint.id}

Using getPrivateEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPrivateEndpoint(args: GetPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointResult>
function getPrivateEndpointOutput(args: GetPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointResult>

def get_private_endpoint(private_endpoint_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointResult
def get_private_endpoint_output(private_endpoint_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointResult]

func LookupPrivateEndpoint(ctx *Context, args *LookupPrivateEndpointArgs, opts ...InvokeOption) (*LookupPrivateEndpointResult, error)
func LookupPrivateEndpointOutput(ctx *Context, args *LookupPrivateEndpointOutputArgs, opts ...InvokeOption) LookupPrivateEndpointResultOutput

> Note: This function is named LookupPrivateEndpoint in the Go SDK.

public static class GetPrivateEndpoint 
{
    public static Task<GetPrivateEndpointResult> InvokeAsync(GetPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointResult> Invoke(GetPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: oci:GloballyDistributedDatabase/getPrivateEndpoint:getPrivateEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

PrivateEndpointId string: Oracle Sharded Database PrivateEndpoint identifier

PrivateEndpointId string: Oracle Sharded Database PrivateEndpoint identifier

privateEndpointId String: Oracle Sharded Database PrivateEndpoint identifier

privateEndpointId string: Oracle Sharded Database PrivateEndpoint identifier

private_endpoint_id str: Oracle Sharded Database PrivateEndpoint identifier

privateEndpointId String: Oracle Sharded Database PrivateEndpoint identifier

getPrivateEndpoint Result

The following output properties are available:

CompartmentId string: Identifier of the compartment in which private endpoint exists.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: PrivateEndpoint description.
DisplayName string: PrivateEndpoint display name.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The identifier of the Private Endpoint.
LifecycleStateDetails string: Detailed message for the lifecycle state.
NsgIds List<string>: The OCIDs of the network security groups that the private endpoint belongs to.
PrivateEndpointId string
PrivateIp string: IP address of the Private Endpoint.
ProxyComputeInstanceId string: The identifier of the proxy compute instance.
ReinstateProxyInstanceTrigger int
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 subnet in which private endpoint exists.
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: Identifier of the compartment in which private endpoint exists.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: PrivateEndpoint description.
DisplayName string: PrivateEndpoint display name.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The identifier of the Private Endpoint.
LifecycleStateDetails string: Detailed message for the lifecycle state.
NsgIds []string: The OCIDs of the network security groups that the private endpoint belongs to.
PrivateEndpointId string
PrivateIp string: IP address of the Private Endpoint.
ProxyComputeInstanceId string: The identifier of the proxy compute instance.
ReinstateProxyInstanceTrigger int
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 subnet in which private endpoint exists.
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: Identifier of the compartment in which private endpoint exists.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: PrivateEndpoint description.
displayName String: PrivateEndpoint display name.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The identifier of the Private Endpoint.
lifecycleStateDetails String: Detailed message for the lifecycle state.
nsgIds List<String>: The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointId String
privateIp String: IP address of the Private Endpoint.
proxyComputeInstanceId String: The identifier of the proxy compute instance.
reinstateProxyInstanceTrigger Integer
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 subnet in which private endpoint exists.
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: Identifier of the compartment in which private endpoint exists.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: PrivateEndpoint description.
displayName string: PrivateEndpoint display name.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The identifier of the Private Endpoint.
lifecycleStateDetails string: Detailed message for the lifecycle state.
nsgIds string[]: The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointId string
privateIp string: IP address of the Private Endpoint.
proxyComputeInstanceId string: The identifier of the proxy compute instance.
reinstateProxyInstanceTrigger number
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 subnet in which private endpoint exists.
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: Identifier of the compartment in which private endpoint exists.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: PrivateEndpoint description.
display_name str: PrivateEndpoint display name.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The identifier of the Private Endpoint.
lifecycle_state_details str: Detailed message for the lifecycle state.
nsg_ids Sequence[str]: The OCIDs of the network security groups that the private endpoint belongs to.
private_endpoint_id str
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
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 subnet in which private endpoint exists.
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: Identifier of the compartment in which private endpoint exists.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: PrivateEndpoint description.
displayName String: PrivateEndpoint display name.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The identifier of the Private Endpoint.
lifecycleStateDetails String: Detailed message for the lifecycle state.
nsgIds List<String>: The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointId String
privateIp String: IP address of the Private Endpoint.
proxyComputeInstanceId String: The identifier of the proxy compute instance.
reinstateProxyInstanceTrigger Number
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 subnet in which private endpoint exists.
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.

Package Details

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

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.GloballyDistributedDatabase.getPrivateEndpoint

On this page

On this page

Example Usage

Using getPrivateEndpoint

getPrivateEndpoint Result

Package Details

On this page

On this page