1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. rdspostgresql
  5. DbEndpoint
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rdspostgresql.DbEndpoint

volcenginecc logo
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    连接终端是位于数据库和应用程序之间的网络代理服务，用于代理应用程序访问数据库时的所有请求，具有高可用、高性能、可运维、简单易用等特点，支持读写分离和负载均衡等高级功能。云数据库 PostgreSQL 版提供了默认终端和自定义只读终端两种类型。

    Example Usage

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

const rdsPostgresqlDbEndpointDemo = new volcenginecc.rdspostgresql.DbEndpoint("RdsPostgresqlDbEndpointDemo", {
    endpointName: "ccapi-test-1",
    endpointType: "Custom",
    instanceId: "postgres-9dxxxxxd",
    nodes: "Primary",
    readWriteMode: "ReadWrite",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

rds_postgresql_db_endpoint_demo = volcenginecc.rdspostgresql.DbEndpoint("RdsPostgresqlDbEndpointDemo",
    endpoint_name="ccapi-test-1",
    endpoint_type="Custom",
    instance_id="postgres-9dxxxxxd",
    nodes="Primary",
    read_write_mode="ReadWrite")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rdspostgresql.NewDbEndpoint(ctx, "RdsPostgresqlDbEndpointDemo", &rdspostgresql.DbEndpointArgs{
			EndpointName:  pulumi.String("ccapi-test-1"),
			EndpointType:  pulumi.String("Custom"),
			InstanceId:    pulumi.String("postgres-9dxxxxxd"),
			Nodes:         pulumi.String("Primary"),
			ReadWriteMode: pulumi.String("ReadWrite"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var rdsPostgresqlDbEndpointDemo = new Volcenginecc.Rdspostgresql.DbEndpoint("RdsPostgresqlDbEndpointDemo", new()
    {
        EndpointName = "ccapi-test-1",
        EndpointType = "Custom",
        InstanceId = "postgres-9dxxxxxd",
        Nodes = "Primary",
        ReadWriteMode = "ReadWrite",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.rdspostgresql.DbEndpoint;
import com.volcengine.volcenginecc.rdspostgresql.DbEndpointArgs;
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 rdsPostgresqlDbEndpointDemo = new DbEndpoint("rdsPostgresqlDbEndpointDemo", DbEndpointArgs.builder()
            .endpointName("ccapi-test-1")
            .endpointType("Custom")
            .instanceId("postgres-9dxxxxxd")
            .nodes("Primary")
            .readWriteMode("ReadWrite")
            .build());

    }
}

    resources:
  rdsPostgresqlDbEndpointDemo:
    type: volcenginecc:rdspostgresql:DbEndpoint
    name: RdsPostgresqlDbEndpointDemo
    properties:
      endpointName: ccapi-test-1
      endpointType: Custom
      instanceId: postgres-9dxxxxxd
      nodes: Primary
      readWriteMode: ReadWrite

    Create DbEndpoint Resource

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

    Constructor syntax

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

@overload
def DbEndpoint(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               addresses: Optional[Sequence[DbEndpointAddressArgs]] = None,
               enable_read_write_splitting: Optional[str] = None,
               endpoint_name: Optional[str] = None,
               endpoint_type: Optional[str] = None,
               instance_id: Optional[str] = None,
               nodes: Optional[str] = None,
               read_only_node_distribution_type: Optional[str] = None,
               read_only_node_max_delay_time: Optional[int] = None,
               read_only_node_weights: Optional[Sequence[DbEndpointReadOnlyNodeWeightArgs]] = None,
               read_write_mode: Optional[str] = None,
               read_write_proxy_connection: Optional[int] = None,
               write_node_halt_writing: Optional[bool] = None)
    func NewDbEndpoint(ctx *Context, name string, args *DbEndpointArgs, opts ...ResourceOption) (*DbEndpoint, error)
    public DbEndpoint(string name, DbEndpointArgs? args = null, CustomResourceOptions? opts = null)
    public DbEndpoint(String name, DbEndpointArgs args)
public DbEndpoint(String name, DbEndpointArgs args, CustomResourceOptions options)

    type: volcenginecc:rdspostgresql:DbEndpoint
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 DbEndpointArgs
    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 DbEndpointArgs
    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 DbEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbEndpointArgs
    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 dbEndpointResource = new Volcenginecc.Rdspostgresql.DbEndpoint("dbEndpointResource", new()
{
    Addresses = new[]
    {
        new Volcenginecc.Rdspostgresql.Inputs.DbEndpointAddressArgs
        {
            DnsVisibility = false,
            DomainPrefix = "string",
            Port = "string",
        },
    },
    EnableReadWriteSplitting = "string",
    EndpointName = "string",
    EndpointType = "string",
    InstanceId = "string",
    Nodes = "string",
    ReadOnlyNodeDistributionType = "string",
    ReadOnlyNodeMaxDelayTime = 0,
    ReadOnlyNodeWeights = new[]
    {
        new Volcenginecc.Rdspostgresql.Inputs.DbEndpointReadOnlyNodeWeightArgs
        {
            NodeId = "string",
            NodeType = "string",
            Weight = 0,
        },
    },
    ReadWriteMode = "string",
    ReadWriteProxyConnection = 0,
    WriteNodeHaltWriting = false,
});

    example, err := rdspostgresql.NewDbEndpoint(ctx, "dbEndpointResource", &rdspostgresql.DbEndpointArgs{
	Addresses: rdspostgresql.DbEndpointAddressArray{
		&rdspostgresql.DbEndpointAddressArgs{
			DnsVisibility: pulumi.Bool(false),
			DomainPrefix:  pulumi.String("string"),
			Port:          pulumi.String("string"),
		},
	},
	EnableReadWriteSplitting:     pulumi.String("string"),
	EndpointName:                 pulumi.String("string"),
	EndpointType:                 pulumi.String("string"),
	InstanceId:                   pulumi.String("string"),
	Nodes:                        pulumi.String("string"),
	ReadOnlyNodeDistributionType: pulumi.String("string"),
	ReadOnlyNodeMaxDelayTime:     pulumi.Int(0),
	ReadOnlyNodeWeights: rdspostgresql.DbEndpointReadOnlyNodeWeightArray{
		&rdspostgresql.DbEndpointReadOnlyNodeWeightArgs{
			NodeId:   pulumi.String("string"),
			NodeType: pulumi.String("string"),
			Weight:   pulumi.Int(0),
		},
	},
	ReadWriteMode:            pulumi.String("string"),
	ReadWriteProxyConnection: pulumi.Int(0),
	WriteNodeHaltWriting:     pulumi.Bool(false),
})

    var dbEndpointResource = new DbEndpoint("dbEndpointResource", DbEndpointArgs.builder()
    .addresses(DbEndpointAddressArgs.builder()
        .dnsVisibility(false)
        .domainPrefix("string")
        .port("string")
        .build())
    .enableReadWriteSplitting("string")
    .endpointName("string")
    .endpointType("string")
    .instanceId("string")
    .nodes("string")
    .readOnlyNodeDistributionType("string")
    .readOnlyNodeMaxDelayTime(0)
    .readOnlyNodeWeights(DbEndpointReadOnlyNodeWeightArgs.builder()
        .nodeId("string")
        .nodeType("string")
        .weight(0)
        .build())
    .readWriteMode("string")
    .readWriteProxyConnection(0)
    .writeNodeHaltWriting(false)
    .build());

    db_endpoint_resource = volcenginecc.rdspostgresql.DbEndpoint("dbEndpointResource",
    addresses=[{
        "dns_visibility": False,
        "domain_prefix": "string",
        "port": "string",
    }],
    enable_read_write_splitting="string",
    endpoint_name="string",
    endpoint_type="string",
    instance_id="string",
    nodes="string",
    read_only_node_distribution_type="string",
    read_only_node_max_delay_time=0,
    read_only_node_weights=[{
        "node_id": "string",
        "node_type": "string",
        "weight": 0,
    }],
    read_write_mode="string",
    read_write_proxy_connection=0,
    write_node_halt_writing=False)

    const dbEndpointResource = new volcenginecc.rdspostgresql.DbEndpoint("dbEndpointResource", {
    addresses: [{
        dnsVisibility: false,
        domainPrefix: "string",
        port: "string",
    }],
    enableReadWriteSplitting: "string",
    endpointName: "string",
    endpointType: "string",
    instanceId: "string",
    nodes: "string",
    readOnlyNodeDistributionType: "string",
    readOnlyNodeMaxDelayTime: 0,
    readOnlyNodeWeights: [{
        nodeId: "string",
        nodeType: "string",
        weight: 0,
    }],
    readWriteMode: "string",
    readWriteProxyConnection: 0,
    writeNodeHaltWriting: false,
});

    type: volcenginecc:rdspostgresql:DbEndpoint
properties:
    addresses:
        - dnsVisibility: false
          domainPrefix: string
          port: string
    enableReadWriteSplitting: string
    endpointName: string
    endpointType: string
    instanceId: string
    nodes: string
    readOnlyNodeDistributionType: string
    readOnlyNodeMaxDelayTime: 0
    readOnlyNodeWeights:
        - nodeId: string
          nodeType: string
          weight: 0
    readWriteMode: string
    readWriteProxyConnection: 0
    writeNodeHaltWriting: false

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

    Addresses List<Volcengine.DbEndpointAddress>
    EnableReadWriteSplitting string
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    EndpointName string
    实例连接终端名称。
    EndpointType string
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    InstanceId string
    实例 ID。
    Nodes string
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    ReadOnlyNodeDistributionType string
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    ReadOnlyNodeMaxDelayTime int
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    ReadOnlyNodeWeights List<Volcengine.DbEndpointReadOnlyNodeWeight>
    ReadWriteMode string
    读写模式：ReadWrite：读写。ReadOnly：只读。
    ReadWriteProxyConnection int
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    WriteNodeHaltWriting bool
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    Addresses []DbEndpointAddressArgs
    EnableReadWriteSplitting string
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    EndpointName string
    实例连接终端名称。
    EndpointType string
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    InstanceId string
    实例 ID。
    Nodes string
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    ReadOnlyNodeDistributionType string
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    ReadOnlyNodeMaxDelayTime int
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    ReadOnlyNodeWeights []DbEndpointReadOnlyNodeWeightArgs
    ReadWriteMode string
    读写模式：ReadWrite：读写。ReadOnly：只读。
    ReadWriteProxyConnection int
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    WriteNodeHaltWriting bool
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses List<DbEndpointAddress>
    enableReadWriteSplitting String
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpointName String
    实例连接终端名称。
    endpointType String
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instanceId String
    实例 ID。
    nodes String
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    readOnlyNodeDistributionType String
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    readOnlyNodeMaxDelayTime Integer
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    readOnlyNodeWeights List<DbEndpointReadOnlyNodeWeight>
    readWriteMode String
    读写模式：ReadWrite：读写。ReadOnly：只读。
    readWriteProxyConnection Integer
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    writeNodeHaltWriting Boolean
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses DbEndpointAddress[]
    enableReadWriteSplitting string
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpointName string
    实例连接终端名称。
    endpointType string
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instanceId string
    实例 ID。
    nodes string
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    readOnlyNodeDistributionType string
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    readOnlyNodeMaxDelayTime number
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    readOnlyNodeWeights DbEndpointReadOnlyNodeWeight[]
    readWriteMode string
    读写模式：ReadWrite：读写。ReadOnly：只读。
    readWriteProxyConnection number
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    writeNodeHaltWriting boolean
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses Sequence[DbEndpointAddressArgs]
    enable_read_write_splitting str
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpoint_name str
    实例连接终端名称。
    endpoint_type str
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instance_id str
    实例 ID。
    nodes str
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    read_only_node_distribution_type str
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    read_only_node_max_delay_time int
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    read_only_node_weights Sequence[DbEndpointReadOnlyNodeWeightArgs]
    read_write_mode str
    读写模式：ReadWrite：读写。ReadOnly：只读。
    read_write_proxy_connection int
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    write_node_halt_writing bool
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses List<Property Map>
    enableReadWriteSplitting String
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpointName String
    实例连接终端名称。
    endpointType String
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instanceId String
    实例 ID。
    nodes String
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    readOnlyNodeDistributionType String
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    readOnlyNodeMaxDelayTime Number
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    readOnlyNodeWeights List<Property Map>
    readWriteMode String
    读写模式：ReadWrite：读写。ReadOnly：只读。
    readWriteProxyConnection Number
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    writeNodeHaltWriting Boolean
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

    Outputs

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

    AutoAddNewNodes string
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    Description string
    地址描述。
    EnableReadOnly string
    是否已开启全局只读。Enable：开启。Disable：未开启。
    EndpointId string
    实例连接终端 ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    AutoAddNewNodes string
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    Description string
    地址描述。
    EnableReadOnly string
    是否已开启全局只读。Enable：开启。Disable：未开启。
    EndpointId string
    实例连接终端 ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    autoAddNewNodes String
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description String
    地址描述。
    enableReadOnly String
    是否已开启全局只读。Enable：开启。Disable：未开启。
    endpointId String
    实例连接终端 ID。
    id String
    The provider-assigned unique ID for this managed resource.
    autoAddNewNodes string
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description string
    地址描述。
    enableReadOnly string
    是否已开启全局只读。Enable：开启。Disable：未开启。
    endpointId string
    实例连接终端 ID。
    id string
    The provider-assigned unique ID for this managed resource.
    auto_add_new_nodes str
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description str
    地址描述。
    enable_read_only str
    是否已开启全局只读。Enable：开启。Disable：未开启。
    endpoint_id str
    实例连接终端 ID。
    id str
    The provider-assigned unique ID for this managed resource.
    autoAddNewNodes String
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description String
    地址描述。
    enableReadOnly String
    是否已开启全局只读。Enable：开启。Disable：未开启。
    endpointId String
    实例连接终端 ID。
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DbEndpoint Resource

    Get an existing DbEndpoint 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?: DbEndpointState, opts?: CustomResourceOptions): DbEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[DbEndpointAddressArgs]] = None,
        auto_add_new_nodes: Optional[str] = None,
        description: Optional[str] = None,
        enable_read_only: Optional[str] = None,
        enable_read_write_splitting: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        nodes: Optional[str] = None,
        read_only_node_distribution_type: Optional[str] = None,
        read_only_node_max_delay_time: Optional[int] = None,
        read_only_node_weights: Optional[Sequence[DbEndpointReadOnlyNodeWeightArgs]] = None,
        read_write_mode: Optional[str] = None,
        read_write_proxy_connection: Optional[int] = None,
        write_node_halt_writing: Optional[bool] = None) -> DbEndpoint
    func GetDbEndpoint(ctx *Context, name string, id IDInput, state *DbEndpointState, opts ...ResourceOption) (*DbEndpoint, error)
    public static DbEndpoint Get(string name, Input<string> id, DbEndpointState? state, CustomResourceOptions? opts = null)
    public static DbEndpoint get(String name, Output<String> id, DbEndpointState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rdspostgresql:DbEndpoint    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:
    Addresses List<Volcengine.DbEndpointAddress>
    AutoAddNewNodes string
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    Description string
    地址描述。
    EnableReadOnly string
    是否已开启全局只读。Enable：开启。Disable：未开启。
    EnableReadWriteSplitting string
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    EndpointId string
    实例连接终端 ID。
    EndpointName string
    实例连接终端名称。
    EndpointType string
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    InstanceId string
    实例 ID。
    Nodes string
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    ReadOnlyNodeDistributionType string
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    ReadOnlyNodeMaxDelayTime int
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    ReadOnlyNodeWeights List<Volcengine.DbEndpointReadOnlyNodeWeight>
    ReadWriteMode string
    读写模式：ReadWrite：读写。ReadOnly：只读。
    ReadWriteProxyConnection int
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    WriteNodeHaltWriting bool
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    Addresses []DbEndpointAddressArgs
    AutoAddNewNodes string
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    Description string
    地址描述。
    EnableReadOnly string
    是否已开启全局只读。Enable：开启。Disable：未开启。
    EnableReadWriteSplitting string
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    EndpointId string
    实例连接终端 ID。
    EndpointName string
    实例连接终端名称。
    EndpointType string
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    InstanceId string
    实例 ID。
    Nodes string
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    ReadOnlyNodeDistributionType string
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    ReadOnlyNodeMaxDelayTime int
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    ReadOnlyNodeWeights []DbEndpointReadOnlyNodeWeightArgs
    ReadWriteMode string
    读写模式：ReadWrite：读写。ReadOnly：只读。
    ReadWriteProxyConnection int
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    WriteNodeHaltWriting bool
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses List<DbEndpointAddress>
    autoAddNewNodes String
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description String
    地址描述。
    enableReadOnly String
    是否已开启全局只读。Enable：开启。Disable：未开启。
    enableReadWriteSplitting String
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpointId String
    实例连接终端 ID。
    endpointName String
    实例连接终端名称。
    endpointType String
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instanceId String
    实例 ID。
    nodes String
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    readOnlyNodeDistributionType String
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    readOnlyNodeMaxDelayTime Integer
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    readOnlyNodeWeights List<DbEndpointReadOnlyNodeWeight>
    readWriteMode String
    读写模式：ReadWrite：读写。ReadOnly：只读。
    readWriteProxyConnection Integer
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    writeNodeHaltWriting Boolean
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses DbEndpointAddress[]
    autoAddNewNodes string
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description string
    地址描述。
    enableReadOnly string
    是否已开启全局只读。Enable：开启。Disable：未开启。
    enableReadWriteSplitting string
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpointId string
    实例连接终端 ID。
    endpointName string
    实例连接终端名称。
    endpointType string
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instanceId string
    实例 ID。
    nodes string
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    readOnlyNodeDistributionType string
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    readOnlyNodeMaxDelayTime number
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    readOnlyNodeWeights DbEndpointReadOnlyNodeWeight[]
    readWriteMode string
    读写模式：ReadWrite：读写。ReadOnly：只读。
    readWriteProxyConnection number
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    writeNodeHaltWriting boolean
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses Sequence[DbEndpointAddressArgs]
    auto_add_new_nodes str
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description str
    地址描述。
    enable_read_only str
    是否已开启全局只读。Enable：开启。Disable：未开启。
    enable_read_write_splitting str
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpoint_id str
    实例连接终端 ID。
    endpoint_name str
    实例连接终端名称。
    endpoint_type str
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instance_id str
    实例 ID。
    nodes str
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    read_only_node_distribution_type str
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    read_only_node_max_delay_time int
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    read_only_node_weights Sequence[DbEndpointReadOnlyNodeWeightArgs]
    read_write_mode str
    读写模式：ReadWrite：读写。ReadOnly：只读。
    read_write_proxy_connection int
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    write_node_halt_writing bool
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。
    addresses List<Property Map>
    autoAddNewNodes String
    当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
    description String
    地址描述。
    enableReadOnly String
    是否已开启全局只读。Enable：开启。Disable：未开启。
    enableReadWriteSplitting String
    是否已开启读写分离，取值：Enable：开启。Disable：未开启。
    endpointId String
    实例连接终端 ID。
    endpointName String
    实例连接终端名称。
    endpointType String
    终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
    instanceId String
    实例 ID。
    nodes String
    连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
    readOnlyNodeDistributionType String
    只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
    readOnlyNodeMaxDelayTime Number
    只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
    readOnlyNodeWeights List<Property Map>
    readWriteMode String
    读写模式：ReadWrite：读写。ReadOnly：只读。
    readWriteProxyConnection Number
    终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
    writeNodeHaltWriting Boolean
    终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

    Supporting Types

    DbEndpointAddress, DbEndpointAddressArgs

    DnsVisibility bool
    是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
    DomainPrefix string
    新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
    Port string
    端口号。
    DnsVisibility bool
    是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
    DomainPrefix string
    新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
    Port string
    端口号。
    dnsVisibility Boolean
    是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
    domainPrefix String
    新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
    port String
    端口号。
    dnsVisibility boolean
    是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
    domainPrefix string
    新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
    port string
    端口号。
    dns_visibility bool
    是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
    domain_prefix str
    新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
    port str
    端口号。
    dnsVisibility Boolean
    是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
    domainPrefix String
    新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
    port String
    端口号。

    DbEndpointReadOnlyNodeWeight, DbEndpointReadOnlyNodeWeightArgs

    NodeId string
    只读节点需要传入 NodeId。
    NodeType string
    节点类型。取值：Primary：主节点。ReadOnly：只读节点。
    Weight int
    节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。
    NodeId string
    只读节点需要传入 NodeId。
    NodeType string
    节点类型。取值：Primary：主节点。ReadOnly：只读节点。
    Weight int
    节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。
    nodeId String
    只读节点需要传入 NodeId。
    nodeType String
    节点类型。取值：Primary：主节点。ReadOnly：只读节点。
    weight Integer
    节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。
    nodeId string
    只读节点需要传入 NodeId。
    nodeType string
    节点类型。取值：Primary：主节点。ReadOnly：只读节点。
    weight number
    节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。
    node_id str
    只读节点需要传入 NodeId。
    node_type str
    节点类型。取值：Primary：主节点。ReadOnly：只读节点。
    weight int
    节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。
    nodeId String
    只读节点需要传入 NodeId。
    nodeType String
    节点类型。取值：Primary：主节点。ReadOnly：只读节点。
    weight Number
    节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。

    Import

    $ pulumi import volcenginecc:rdspostgresql/dbEndpoint:DbEndpoint example "instance_id|endpoint_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.24
    published on Monday, Mar 9, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.