1. Packages
  2. Volcengine
  3. API Docs
  4. rds_postgresql
  5. getDatabaseEndpoints
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rds_postgresql.getDatabaseEndpoints

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of rds postgresql database endpoints

    Example Usage

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

const example = volcengine.rds_postgresql.getDatabaseEndpoints({
    instanceId: "postgres-72715e0d9f58",
    nameRegex: "默认.*",
});

    import pulumi
import pulumi_volcengine as volcengine

example = volcengine.rds_postgresql.get_database_endpoints(instance_id="postgres-72715e0d9f58",
    name_regex="默认.*")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_postgresql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_postgresql.GetDatabaseEndpoints(ctx, &rds_postgresql.GetDatabaseEndpointsArgs{
			InstanceId: pulumi.StringRef("postgres-72715e0d9f58"),
			NameRegex:  pulumi.StringRef("默认.*"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Volcengine.Rds_postgresql.GetDatabaseEndpoints.Invoke(new()
    {
        InstanceId = "postgres-72715e0d9f58",
        NameRegex = "默认.*",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_postgresql.Rds_postgresqlFunctions;
import com.pulumi.volcengine.rds_postgresql.inputs.GetDatabaseEndpointsArgs;
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 example = Rds_postgresqlFunctions.getDatabaseEndpoints(GetDatabaseEndpointsArgs.builder()
            .instanceId("postgres-72715e0d9f58")
            .nameRegex("默认.*")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: volcengine:rds_postgresql:getDatabaseEndpoints
      Arguments:
        instanceId: postgres-72715e0d9f58
        nameRegex: 默认.*

    Using getDatabaseEndpoints

    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 getDatabaseEndpoints(args: GetDatabaseEndpointsArgs, opts?: InvokeOptions): Promise<GetDatabaseEndpointsResult>
function getDatabaseEndpointsOutput(args: GetDatabaseEndpointsOutputArgs, opts?: InvokeOptions): Output<GetDatabaseEndpointsResult>
    def get_database_endpoints(instance_id: Optional[str] = None,
                           name_regex: Optional[str] = None,
                           output_file: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDatabaseEndpointsResult
def get_database_endpoints_output(instance_id: Optional[pulumi.Input[str]] = None,
                           name_regex: Optional[pulumi.Input[str]] = None,
                           output_file: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseEndpointsResult]
    func GetDatabaseEndpoints(ctx *Context, args *GetDatabaseEndpointsArgs, opts ...InvokeOption) (*GetDatabaseEndpointsResult, error)
func GetDatabaseEndpointsOutput(ctx *Context, args *GetDatabaseEndpointsOutputArgs, opts ...InvokeOption) GetDatabaseEndpointsResultOutput

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

    public static class GetDatabaseEndpoints 
{
    public static Task<GetDatabaseEndpointsResult> InvokeAsync(GetDatabaseEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseEndpointsResult> Invoke(GetDatabaseEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseEndpointsResult> getDatabaseEndpoints(GetDatabaseEndpointsArgs args, InvokeOptions options)
public static Output<GetDatabaseEndpointsResult> getDatabaseEndpoints(GetDatabaseEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rds_postgresql/getDatabaseEndpoints:getDatabaseEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The ID of the RDS PostgreSQL instance.
    NameRegex string
    The name of the endpoint to filter.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The ID of the RDS PostgreSQL instance.
    NameRegex string
    The name of the endpoint to filter.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The ID of the RDS PostgreSQL instance.
    nameRegex String
    The name of the endpoint to filter.
    outputFile String
    File name where to save data source results.
    instanceId string
    The ID of the RDS PostgreSQL instance.
    nameRegex string
    The name of the endpoint to filter.
    outputFile string
    File name where to save data source results.
    instance_id str
    The ID of the RDS PostgreSQL instance.
    name_regex str
    The name of the endpoint to filter.
    output_file str
    File name where to save data source results.
    instanceId String
    The ID of the RDS PostgreSQL instance.
    nameRegex String
    The name of the endpoint to filter.
    outputFile String
    File name where to save data source results.

    getDatabaseEndpoints Result

    The following output properties are available:

    Endpoints List<GetDatabaseEndpointsEndpoint>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    InstanceId string
    NameRegex string
    OutputFile string
    Endpoints []GetDatabaseEndpointsEndpoint
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    InstanceId string
    NameRegex string
    OutputFile string
    endpoints List<GetDatabaseEndpointsEndpoint>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    instanceId String
    nameRegex String
    outputFile String
    endpoints GetDatabaseEndpointsEndpoint[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    instanceId string
    nameRegex string
    outputFile string
    endpoints Sequence[GetDatabaseEndpointsEndpoint]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    instance_id str
    name_regex str
    output_file str
    endpoints List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    instanceId String
    nameRegex String
    outputFile String

    Supporting Types

    GetDatabaseEndpointsEndpoint

    CrossRegionDomain string
    Cross-region domain for private address.
    DnsVisibility bool
    Whether to enable public network resolution.
    Domain string
    Connect domain name.
    EndpointId string
    The ID of the RDS PostgreSQL database endpoint.
    EndpointName string
    The name of the RDS PostgreSQL database endpoint.
    EndpointType string
    The type of the RDS PostgreSQL database endpoint. Valid values: Custom(custom endpoint), Cluster(default endpoint).
    Port string
    The endpoint port.
    ReadOnlyNodeDistributionType string
    The distribution type of the read-only nodes.
    ReadOnlyNodeMaxDelayTime int
    ReadOnly node max delay seconds.
    ReadWriteMode string
    ReadWrite or ReadOnly. Default value is ReadOnly.
    ReadWriteProxyConnection int
    The number of proxy connections set for the terminal.
    WriteNodeHaltWriting bool
    Whether the endpoint sends write requests to the write node.
    CrossRegionDomain string
    Cross-region domain for private address.
    DnsVisibility bool
    Whether to enable public network resolution.
    Domain string
    Connect domain name.
    EndpointId string
    The ID of the RDS PostgreSQL database endpoint.
    EndpointName string
    The name of the RDS PostgreSQL database endpoint.
    EndpointType string
    The type of the RDS PostgreSQL database endpoint. Valid values: Custom(custom endpoint), Cluster(default endpoint).
    Port string
    The endpoint port.
    ReadOnlyNodeDistributionType string
    The distribution type of the read-only nodes.
    ReadOnlyNodeMaxDelayTime int
    ReadOnly node max delay seconds.
    ReadWriteMode string
    ReadWrite or ReadOnly. Default value is ReadOnly.
    ReadWriteProxyConnection int
    The number of proxy connections set for the terminal.
    WriteNodeHaltWriting bool
    Whether the endpoint sends write requests to the write node.
    crossRegionDomain String
    Cross-region domain for private address.
    dnsVisibility Boolean
    Whether to enable public network resolution.
    domain String
    Connect domain name.
    endpointId String
    The ID of the RDS PostgreSQL database endpoint.
    endpointName String
    The name of the RDS PostgreSQL database endpoint.
    endpointType String
    The type of the RDS PostgreSQL database endpoint. Valid values: Custom(custom endpoint), Cluster(default endpoint).
    port String
    The endpoint port.
    readOnlyNodeDistributionType String
    The distribution type of the read-only nodes.
    readOnlyNodeMaxDelayTime Integer
    ReadOnly node max delay seconds.
    readWriteMode String
    ReadWrite or ReadOnly. Default value is ReadOnly.
    readWriteProxyConnection Integer
    The number of proxy connections set for the terminal.
    writeNodeHaltWriting Boolean
    Whether the endpoint sends write requests to the write node.
    crossRegionDomain string
    Cross-region domain for private address.
    dnsVisibility boolean
    Whether to enable public network resolution.
    domain string
    Connect domain name.
    endpointId string
    The ID of the RDS PostgreSQL database endpoint.
    endpointName string
    The name of the RDS PostgreSQL database endpoint.
    endpointType string
    The type of the RDS PostgreSQL database endpoint. Valid values: Custom(custom endpoint), Cluster(default endpoint).
    port string
    The endpoint port.
    readOnlyNodeDistributionType string
    The distribution type of the read-only nodes.
    readOnlyNodeMaxDelayTime number
    ReadOnly node max delay seconds.
    readWriteMode string
    ReadWrite or ReadOnly. Default value is ReadOnly.
    readWriteProxyConnection number
    The number of proxy connections set for the terminal.
    writeNodeHaltWriting boolean
    Whether the endpoint sends write requests to the write node.
    cross_region_domain str
    Cross-region domain for private address.
    dns_visibility bool
    Whether to enable public network resolution.
    domain str
    Connect domain name.
    endpoint_id str
    The ID of the RDS PostgreSQL database endpoint.
    endpoint_name str
    The name of the RDS PostgreSQL database endpoint.
    endpoint_type str
    The type of the RDS PostgreSQL database endpoint. Valid values: Custom(custom endpoint), Cluster(default endpoint).
    port str
    The endpoint port.
    read_only_node_distribution_type str
    The distribution type of the read-only nodes.
    read_only_node_max_delay_time int
    ReadOnly node max delay seconds.
    read_write_mode str
    ReadWrite or ReadOnly. Default value is ReadOnly.
    read_write_proxy_connection int
    The number of proxy connections set for the terminal.
    write_node_halt_writing bool
    Whether the endpoint sends write requests to the write node.
    crossRegionDomain String
    Cross-region domain for private address.
    dnsVisibility Boolean
    Whether to enable public network resolution.
    domain String
    Connect domain name.
    endpointId String
    The ID of the RDS PostgreSQL database endpoint.
    endpointName String
    The name of the RDS PostgreSQL database endpoint.
    endpointType String
    The type of the RDS PostgreSQL database endpoint. Valid values: Custom(custom endpoint), Cluster(default endpoint).
    port String
    The endpoint port.
    readOnlyNodeDistributionType String
    The distribution type of the read-only nodes.
    readOnlyNodeMaxDelayTime Number
    ReadOnly node max delay seconds.
    readWriteMode String
    ReadWrite or ReadOnly. Default value is ReadOnly.
    readWriteProxyConnection Number
    The number of proxy connections set for the terminal.
    writeNodeHaltWriting Boolean
    Whether the endpoint sends write requests to the write node.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate