Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.DatabaseTools.getDatabaseToolsPrivateEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

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

const testDatabaseToolsPrivateEndpoint = oci.DatabaseTools.getDatabaseToolsPrivateEndpoint({
    databaseToolsPrivateEndpointId: testDatabaseToolsPrivateEndpointOciDatabaseToolsDatabaseToolsPrivateEndpoint.id,
});

import pulumi
import pulumi_oci as oci

test_database_tools_private_endpoint = oci.DatabaseTools.get_database_tools_private_endpoint(database_tools_private_endpoint_id=test_database_tools_private_endpoint_oci_database_tools_database_tools_private_endpoint["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasetools.GetDatabaseToolsPrivateEndpoint(ctx, &databasetools.GetDatabaseToolsPrivateEndpointArgs{
			DatabaseToolsPrivateEndpointId: testDatabaseToolsPrivateEndpointOciDatabaseToolsDatabaseToolsPrivateEndpoint.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 testDatabaseToolsPrivateEndpoint = Oci.DatabaseTools.GetDatabaseToolsPrivateEndpoint.Invoke(new()
    {
        DatabaseToolsPrivateEndpointId = testDatabaseToolsPrivateEndpointOciDatabaseToolsDatabaseToolsPrivateEndpoint.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseTools.DatabaseToolsFunctions;
import com.pulumi.oci.DatabaseTools.inputs.GetDatabaseToolsPrivateEndpointArgs;
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 testDatabaseToolsPrivateEndpoint = DatabaseToolsFunctions.getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointArgs.builder()
            .databaseToolsPrivateEndpointId(testDatabaseToolsPrivateEndpointOciDatabaseToolsDatabaseToolsPrivateEndpoint.id())
            .build());

    }
}

variables:
  testDatabaseToolsPrivateEndpoint:
    fn::invoke:
      function: oci:DatabaseTools:getDatabaseToolsPrivateEndpoint
      arguments:
        databaseToolsPrivateEndpointId: ${testDatabaseToolsPrivateEndpointOciDatabaseToolsDatabaseToolsPrivateEndpoint.id}

Using getDatabaseToolsPrivateEndpoint

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 getDatabaseToolsPrivateEndpoint(args: GetDatabaseToolsPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetDatabaseToolsPrivateEndpointResult>
function getDatabaseToolsPrivateEndpointOutput(args: GetDatabaseToolsPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetDatabaseToolsPrivateEndpointResult>

def get_database_tools_private_endpoint(database_tools_private_endpoint_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetDatabaseToolsPrivateEndpointResult
def get_database_tools_private_endpoint_output(database_tools_private_endpoint_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseToolsPrivateEndpointResult]

func GetDatabaseToolsPrivateEndpoint(ctx *Context, args *GetDatabaseToolsPrivateEndpointArgs, opts ...InvokeOption) (*GetDatabaseToolsPrivateEndpointResult, error)
func GetDatabaseToolsPrivateEndpointOutput(ctx *Context, args *GetDatabaseToolsPrivateEndpointOutputArgs, opts ...InvokeOption) GetDatabaseToolsPrivateEndpointResultOutput

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

public static class GetDatabaseToolsPrivateEndpoint 
{
    public static Task<GetDatabaseToolsPrivateEndpointResult> InvokeAsync(GetDatabaseToolsPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseToolsPrivateEndpointResult> Invoke(GetDatabaseToolsPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseToolsPrivateEndpointResult> getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointArgs args, InvokeOptions options)
public static Output<GetDatabaseToolsPrivateEndpointResult> getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DatabaseTools/getDatabaseToolsPrivateEndpoint:getDatabaseToolsPrivateEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseToolsPrivateEndpointId string: The OCID of a Database Tools private endpoint.

DatabaseToolsPrivateEndpointId string: The OCID of a Database Tools private endpoint.

databaseToolsPrivateEndpointId String: The OCID of a Database Tools private endpoint.

databaseToolsPrivateEndpointId string: The OCID of a Database Tools private endpoint.

database_tools_private_endpoint_id str: The OCID of a Database Tools private endpoint.

databaseToolsPrivateEndpointId String: The OCID of a Database Tools private endpoint.

getDatabaseToolsPrivateEndpoint Result

The following output properties are available:

AdditionalFqdns List<string>: A list of additional FQDNs that can be also be used for the private endpoint.
CompartmentId string: The OCID of the compartment containing the Database Tools private endpoint.
DatabaseToolsPrivateEndpointId string
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: A description of the Database Tools private endpoint.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EndpointFqdn string: Then FQDN to use for the private endpoint.
EndpointServiceId string: The OCID of the Database Tools Endpoint Service.
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 OCID of the Database Tools private endpoint.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Locks List<GetDatabaseToolsPrivateEndpointLock>: Locks associated with this resource.
NsgIds List<string>: The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
PrivateEndpointIp string: The private IP address that represents the access point for the associated endpoint service.
PrivateEndpointVnicId string: The OCID of the private endpoint's VNIC.
ReverseConnectionConfigurations List<GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration>: Reverse connection configuration details of the private endpoint.
State string: The current state of the Database Tools private endpoint.
SubnetId string: The OCID of the subnet that the private endpoint belongs to.
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 Database Tools private endpoint was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
VcnId string: The OCID of the VCN that the private endpoint belongs to.

AdditionalFqdns []string: A list of additional FQDNs that can be also be used for the private endpoint.
CompartmentId string: The OCID of the compartment containing the Database Tools private endpoint.
DatabaseToolsPrivateEndpointId string
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: A description of the Database Tools private endpoint.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EndpointFqdn string: Then FQDN to use for the private endpoint.
EndpointServiceId string: The OCID of the Database Tools Endpoint Service.
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 OCID of the Database Tools private endpoint.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Locks []GetDatabaseToolsPrivateEndpointLock: Locks associated with this resource.
NsgIds []string: The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
PrivateEndpointIp string: The private IP address that represents the access point for the associated endpoint service.
PrivateEndpointVnicId string: The OCID of the private endpoint's VNIC.
ReverseConnectionConfigurations []GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration: Reverse connection configuration details of the private endpoint.
State string: The current state of the Database Tools private endpoint.
SubnetId string: The OCID of the subnet that the private endpoint belongs to.
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 Database Tools private endpoint was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
VcnId string: The OCID of the VCN that the private endpoint belongs to.

additionalFqdns List<String>: A list of additional FQDNs that can be also be used for the private endpoint.
compartmentId String: The OCID of the compartment containing the Database Tools private endpoint.
databaseToolsPrivateEndpointId String
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: A description of the Database Tools private endpoint.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
endpointFqdn String: Then FQDN to use for the private endpoint.
endpointServiceId String: The OCID of the Database Tools Endpoint Service.
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 OCID of the Database Tools private endpoint.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
locks List<GetPrivateEndpointLock>: Locks associated with this resource.
nsgIds List<String>: The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
privateEndpointIp String: The private IP address that represents the access point for the associated endpoint service.
privateEndpointVnicId String: The OCID of the private endpoint's VNIC.
reverseConnectionConfigurations List<GetPrivateEndpointReverseConnectionConfiguration>: Reverse connection configuration details of the private endpoint.
state String: The current state of the Database Tools private endpoint.
subnetId String: The OCID of the subnet that the private endpoint belongs to.
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 Database Tools private endpoint was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
vcnId String: The OCID of the VCN that the private endpoint belongs to.

additionalFqdns string[]: A list of additional FQDNs that can be also be used for the private endpoint.
compartmentId string: The OCID of the compartment containing the Database Tools private endpoint.
databaseToolsPrivateEndpointId string
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: A description of the Database Tools private endpoint.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
endpointFqdn string: Then FQDN to use for the private endpoint.
endpointServiceId string: The OCID of the Database Tools Endpoint Service.
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 OCID of the Database Tools private endpoint.
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
locks GetDatabaseToolsPrivateEndpointLock[]: Locks associated with this resource.
nsgIds string[]: The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
privateEndpointIp string: The private IP address that represents the access point for the associated endpoint service.
privateEndpointVnicId string: The OCID of the private endpoint's VNIC.
reverseConnectionConfigurations GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration[]: Reverse connection configuration details of the private endpoint.
state string: The current state of the Database Tools private endpoint.
subnetId string: The OCID of the subnet that the private endpoint belongs to.
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 Database Tools private endpoint was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
vcnId string: The OCID of the VCN that the private endpoint belongs to.

additional_fqdns Sequence[str]: A list of additional FQDNs that can be also be used for the private endpoint.
compartment_id str: The OCID of the compartment containing the Database Tools private endpoint.
database_tools_private_endpoint_id str
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: A description of the Database Tools private endpoint.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
endpoint_fqdn str: Then FQDN to use for the private endpoint.
endpoint_service_id str: The OCID of the Database Tools Endpoint Service.
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 OCID of the Database Tools private endpoint.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
locks Sequence[databasetools.GetDatabaseToolsPrivateEndpointLock]: Locks associated with this resource.
nsg_ids Sequence[str]: The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
private_endpoint_ip str: The private IP address that represents the access point for the associated endpoint service.
private_endpoint_vnic_id str: The OCID of the private endpoint's VNIC.
reverse_connection_configurations Sequence[databasetools.GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration]: Reverse connection configuration details of the private endpoint.
state str: The current state of the Database Tools private endpoint.
subnet_id str: The OCID of the subnet that the private endpoint belongs to.
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 Database Tools private endpoint was created. An RFC3339 formatted datetime string
time_updated str: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
vcn_id str: The OCID of the VCN that the private endpoint belongs to.

additionalFqdns List<String>: A list of additional FQDNs that can be also be used for the private endpoint.
compartmentId String: The OCID of the compartment containing the Database Tools private endpoint.
databaseToolsPrivateEndpointId String
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: A description of the Database Tools private endpoint.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
endpointFqdn String: Then FQDN to use for the private endpoint.
endpointServiceId String: The OCID of the Database Tools Endpoint Service.
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 OCID of the Database Tools private endpoint.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
locks List<Property Map>: Locks associated with this resource.
nsgIds List<String>: The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
privateEndpointIp String: The private IP address that represents the access point for the associated endpoint service.
privateEndpointVnicId String: The OCID of the private endpoint's VNIC.
reverseConnectionConfigurations List<Property Map>: Reverse connection configuration details of the private endpoint.
state String: The current state of the Database Tools private endpoint.
subnetId String: The OCID of the subnet that the private endpoint belongs to.
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 Database Tools private endpoint was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
vcnId String: The OCID of the VCN that the private endpoint belongs to.

Supporting Types

GetDatabaseToolsPrivateEndpointLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
type String: Type of the lock.

GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration

ReverseConnectionsSourceIps List<GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp>: A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.

ReverseConnectionsSourceIps []GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp: A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.

reverseConnectionsSourceIps List<GetPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp>: A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.

reverseConnectionsSourceIps GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp[]: A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.

reverse_connections_source_ips Sequence[databasetools.GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp]: A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.

reverseConnectionsSourceIps List<Property Map>: A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.

GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp

SourceIp string: The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.

SourceIp string: The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.

sourceIp String: The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.

sourceIp string: The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.

source_ip str: The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.

sourceIp String: The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.DatabaseTools.getDatabaseToolsPrivateEndpoint

On this page

On this page

Example Usage

Using getDatabaseToolsPrivateEndpoint

getDatabaseToolsPrivateEndpoint Result

Supporting Types

GetDatabaseToolsPrivateEndpointLock

GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration

GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp

Package Details

On this page

On this page