published on Monday, May 25, 2026 by Byteplus
published on Monday, May 25, 2026 by Byteplus
The connection endpoint is a network proxy service positioned between the database and the application, handling all requests from the application to the database. It features high availability, high performance, maintainability, and ease of use, and supports advanced functions such as read/write splitting and load balancing. The PostgreSQL cloud database provides two types of endpoints: default endpoint and custom read-only endpoint.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
rdsPostgresqlDbEndpointDemo:
type: bytepluscc:rdspostgresql:DbEndpoint
name: RdsPostgresqlDbEndpointDemo
properties:
endpointName: ccapi-test-1
endpointType: Custom
instanceId: postgres-9dxxxxxd
nodes: Primary
readWriteMode: ReadWrite
publicAddresses:
eip_id: eip-0xxxxx8c45
Example coming soon!
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,
enable_read_write_splitting: Optional[str] = None,
endpoint_name: Optional[str] = None,
endpoint_type: Optional[str] = None,
inner_addresses: Optional[DbEndpointInnerAddressesArgs] = None,
instance_id: Optional[str] = None,
nodes: Optional[str] = None,
private_addresses: Optional[DbEndpointPrivateAddressesArgs] = None,
public_addresses: Optional[DbEndpointPublicAddressesArgs] = 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: bytepluscc:rdspostgresql:DbEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "bytepluscc_rdspostgresql_dbendpoint" "name" {
# resource properties
}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 Bytepluscc.Rdspostgresql.DbEndpoint("dbEndpointResource", new()
{
EnableReadWriteSplitting = "string",
EndpointName = "string",
EndpointType = "string",
InnerAddresses = new Bytepluscc.Rdspostgresql.Inputs.DbEndpointInnerAddressesArgs
{
CrossRegionDomain = "string",
DnsVisibility = false,
Domain = "string",
DomainPrefix = "string",
DomainVisibilitySetting = "string",
EipId = "string",
IpAddress = "string",
NetworkType = "string",
Port = "string",
SubnetId = "string",
},
InstanceId = "string",
Nodes = "string",
PrivateAddresses = new Bytepluscc.Rdspostgresql.Inputs.DbEndpointPrivateAddressesArgs
{
CrossRegionDomain = "string",
DnsVisibility = false,
Domain = "string",
DomainPrefix = "string",
DomainVisibilitySetting = "string",
EipId = "string",
IpAddress = "string",
NetworkType = "string",
Port = "string",
SubnetId = "string",
},
PublicAddresses = new Bytepluscc.Rdspostgresql.Inputs.DbEndpointPublicAddressesArgs
{
CrossRegionDomain = "string",
DnsVisibility = false,
Domain = "string",
DomainPrefix = "string",
DomainVisibilitySetting = "string",
EipId = "string",
IpAddress = "string",
NetworkType = "string",
Port = "string",
SubnetId = "string",
},
ReadOnlyNodeDistributionType = "string",
ReadOnlyNodeMaxDelayTime = 0,
ReadOnlyNodeWeights = new[]
{
new Bytepluscc.Rdspostgresql.Inputs.DbEndpointReadOnlyNodeWeightArgs
{
NodeId = "string",
NodeType = "string",
Weight = 0,
},
},
ReadWriteMode = "string",
ReadWriteProxyConnection = 0,
WriteNodeHaltWriting = false,
});
example, err := rdspostgresql.NewDbEndpoint(ctx, "dbEndpointResource", &rdspostgresql.DbEndpointArgs{
EnableReadWriteSplitting: pulumi.String("string"),
EndpointName: pulumi.String("string"),
EndpointType: pulumi.String("string"),
InnerAddresses: &rdspostgresql.DbEndpointInnerAddressesArgs{
CrossRegionDomain: pulumi.String("string"),
DnsVisibility: pulumi.Bool(false),
Domain: pulumi.String("string"),
DomainPrefix: pulumi.String("string"),
DomainVisibilitySetting: pulumi.String("string"),
EipId: pulumi.String("string"),
IpAddress: pulumi.String("string"),
NetworkType: pulumi.String("string"),
Port: pulumi.String("string"),
SubnetId: pulumi.String("string"),
},
InstanceId: pulumi.String("string"),
Nodes: pulumi.String("string"),
PrivateAddresses: &rdspostgresql.DbEndpointPrivateAddressesArgs{
CrossRegionDomain: pulumi.String("string"),
DnsVisibility: pulumi.Bool(false),
Domain: pulumi.String("string"),
DomainPrefix: pulumi.String("string"),
DomainVisibilitySetting: pulumi.String("string"),
EipId: pulumi.String("string"),
IpAddress: pulumi.String("string"),
NetworkType: pulumi.String("string"),
Port: pulumi.String("string"),
SubnetId: pulumi.String("string"),
},
PublicAddresses: &rdspostgresql.DbEndpointPublicAddressesArgs{
CrossRegionDomain: pulumi.String("string"),
DnsVisibility: pulumi.Bool(false),
Domain: pulumi.String("string"),
DomainPrefix: pulumi.String("string"),
DomainVisibilitySetting: pulumi.String("string"),
EipId: pulumi.String("string"),
IpAddress: pulumi.String("string"),
NetworkType: pulumi.String("string"),
Port: pulumi.String("string"),
SubnetId: 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),
})
resource "bytepluscc_rdspostgresql_dbendpoint" "dbEndpointResource" {
enable_read_write_splitting = "string"
endpoint_name = "string"
endpoint_type = "string"
inner_addresses = {
cross_region_domain = "string"
dns_visibility = false
domain = "string"
domain_prefix = "string"
domain_visibility_setting = "string"
eip_id = "string"
ip_address = "string"
network_type = "string"
port = "string"
subnet_id = "string"
}
instance_id = "string"
nodes = "string"
private_addresses = {
cross_region_domain = "string"
dns_visibility = false
domain = "string"
domain_prefix = "string"
domain_visibility_setting = "string"
eip_id = "string"
ip_address = "string"
network_type = "string"
port = "string"
subnet_id = "string"
}
public_addresses = {
cross_region_domain = "string"
dns_visibility = false
domain = "string"
domain_prefix = "string"
domain_visibility_setting = "string"
eip_id = "string"
ip_address = "string"
network_type = "string"
port = "string"
subnet_id = "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
}
var dbEndpointResource = new DbEndpoint("dbEndpointResource", DbEndpointArgs.builder()
.enableReadWriteSplitting("string")
.endpointName("string")
.endpointType("string")
.innerAddresses(DbEndpointInnerAddressesArgs.builder()
.crossRegionDomain("string")
.dnsVisibility(false)
.domain("string")
.domainPrefix("string")
.domainVisibilitySetting("string")
.eipId("string")
.ipAddress("string")
.networkType("string")
.port("string")
.subnetId("string")
.build())
.instanceId("string")
.nodes("string")
.privateAddresses(DbEndpointPrivateAddressesArgs.builder()
.crossRegionDomain("string")
.dnsVisibility(false)
.domain("string")
.domainPrefix("string")
.domainVisibilitySetting("string")
.eipId("string")
.ipAddress("string")
.networkType("string")
.port("string")
.subnetId("string")
.build())
.publicAddresses(DbEndpointPublicAddressesArgs.builder()
.crossRegionDomain("string")
.dnsVisibility(false)
.domain("string")
.domainPrefix("string")
.domainVisibilitySetting("string")
.eipId("string")
.ipAddress("string")
.networkType("string")
.port("string")
.subnetId("string")
.build())
.readOnlyNodeDistributionType("string")
.readOnlyNodeMaxDelayTime(0)
.readOnlyNodeWeights(DbEndpointReadOnlyNodeWeightArgs.builder()
.nodeId("string")
.nodeType("string")
.weight(0)
.build())
.readWriteMode("string")
.readWriteProxyConnection(0)
.writeNodeHaltWriting(false)
.build());
db_endpoint_resource = bytepluscc.rdspostgresql.DbEndpoint("dbEndpointResource",
enable_read_write_splitting="string",
endpoint_name="string",
endpoint_type="string",
inner_addresses={
"cross_region_domain": "string",
"dns_visibility": False,
"domain": "string",
"domain_prefix": "string",
"domain_visibility_setting": "string",
"eip_id": "string",
"ip_address": "string",
"network_type": "string",
"port": "string",
"subnet_id": "string",
},
instance_id="string",
nodes="string",
private_addresses={
"cross_region_domain": "string",
"dns_visibility": False,
"domain": "string",
"domain_prefix": "string",
"domain_visibility_setting": "string",
"eip_id": "string",
"ip_address": "string",
"network_type": "string",
"port": "string",
"subnet_id": "string",
},
public_addresses={
"cross_region_domain": "string",
"dns_visibility": False,
"domain": "string",
"domain_prefix": "string",
"domain_visibility_setting": "string",
"eip_id": "string",
"ip_address": "string",
"network_type": "string",
"port": "string",
"subnet_id": "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 bytepluscc.rdspostgresql.DbEndpoint("dbEndpointResource", {
enableReadWriteSplitting: "string",
endpointName: "string",
endpointType: "string",
innerAddresses: {
crossRegionDomain: "string",
dnsVisibility: false,
domain: "string",
domainPrefix: "string",
domainVisibilitySetting: "string",
eipId: "string",
ipAddress: "string",
networkType: "string",
port: "string",
subnetId: "string",
},
instanceId: "string",
nodes: "string",
privateAddresses: {
crossRegionDomain: "string",
dnsVisibility: false,
domain: "string",
domainPrefix: "string",
domainVisibilitySetting: "string",
eipId: "string",
ipAddress: "string",
networkType: "string",
port: "string",
subnetId: "string",
},
publicAddresses: {
crossRegionDomain: "string",
dnsVisibility: false,
domain: "string",
domainPrefix: "string",
domainVisibilitySetting: "string",
eipId: "string",
ipAddress: "string",
networkType: "string",
port: "string",
subnetId: "string",
},
readOnlyNodeDistributionType: "string",
readOnlyNodeMaxDelayTime: 0,
readOnlyNodeWeights: [{
nodeId: "string",
nodeType: "string",
weight: 0,
}],
readWriteMode: "string",
readWriteProxyConnection: 0,
writeNodeHaltWriting: false,
});
type: bytepluscc:rdspostgresql:DbEndpoint
properties:
enableReadWriteSplitting: string
endpointName: string
endpointType: string
innerAddresses:
crossRegionDomain: string
dnsVisibility: false
domain: string
domainPrefix: string
domainVisibilitySetting: string
eipId: string
ipAddress: string
networkType: string
port: string
subnetId: string
instanceId: string
nodes: string
privateAddresses:
crossRegionDomain: string
dnsVisibility: false
domain: string
domainPrefix: string
domainVisibilitySetting: string
eipId: string
ipAddress: string
networkType: string
port: string
subnetId: string
publicAddresses:
crossRegionDomain: string
dnsVisibility: false
domain: string
domainPrefix: string
domainVisibilitySetting: string
eipId: string
ipAddress: string
networkType: string
port: string
subnetId: 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:
- Enable
Read stringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- Endpoint
Name string - Instance connection endpoint name.
- Endpoint
Type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- Inner
Addresses Byteplus.Db Endpoint Inner Addresses - Public service zone connection address
- Instance
Id string - Instance ID.
- Nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- Private
Addresses Byteplus.Db Endpoint Private Addresses - Private network connection address
- Public
Addresses Byteplus.Db Endpoint Public Addresses - Public network connection address
- Read
Only stringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- Read
Only intNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- Read
Only List<Byteplus.Node Weights Db Endpoint Read Only Node Weight> - Read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- Read
Write intProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- Write
Node boolHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- Enable
Read stringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- Endpoint
Name string - Instance connection endpoint name.
- Endpoint
Type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- Inner
Addresses DbEndpoint Inner Addresses Args - Public service zone connection address
- Instance
Id string - Instance ID.
- Nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- Private
Addresses DbEndpoint Private Addresses Args - Private network connection address
- Public
Addresses DbEndpoint Public Addresses Args - Public network connection address
- Read
Only stringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- Read
Only intNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- Read
Only []DbNode Weights Endpoint Read Only Node Weight Args - Read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- Read
Write intProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- Write
Node boolHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- enable_
read_ stringwrite_ splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint_
name string - Instance connection endpoint name.
- endpoint_
type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner_
addresses object - Public service zone connection address
- instance_
id string - Instance ID.
- nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private_
addresses object - Private network connection address
- public_
addresses object - Public network connection address
- read_
only_ stringnode_ distribution_ type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read_
only_ numbernode_ max_ delay_ time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read_
only_ list(object)node_ weights - read_
write_ stringmode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read_
write_ numberproxy_ connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write_
node_ boolhalt_ writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- enable
Read StringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Name String - Instance connection endpoint name.
- endpoint
Type String - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner
Addresses DbEndpoint Inner Addresses - Public service zone connection address
- instance
Id String - Instance ID.
- nodes String
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private
Addresses DbEndpoint Private Addresses - Private network connection address
- public
Addresses DbEndpoint Public Addresses - Public network connection address
- read
Only StringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read
Only IntegerNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read
Only List<DbNode Weights Endpoint Read Only Node Weight> - read
Write StringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read
Write IntegerProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write
Node BooleanHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- enable
Read stringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Name string - Instance connection endpoint name.
- endpoint
Type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner
Addresses DbEndpoint Inner Addresses - Public service zone connection address
- instance
Id string - Instance ID.
- nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private
Addresses DbEndpoint Private Addresses - Private network connection address
- public
Addresses DbEndpoint Public Addresses - Public network connection address
- read
Only stringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read
Only numberNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read
Only DbNode Weights Endpoint Read Only Node Weight[] - read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read
Write numberProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write
Node booleanHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- enable_
read_ strwrite_ splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint_
name str - Instance connection endpoint name.
- endpoint_
type str - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner_
addresses DbEndpoint Inner Addresses Args - Public service zone connection address
- instance_
id str - Instance ID.
- nodes str
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private_
addresses DbEndpoint Private Addresses Args - Private network connection address
- public_
addresses DbEndpoint Public Addresses Args - Public network connection address
- read_
only_ strnode_ distribution_ type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read_
only_ intnode_ max_ delay_ time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read_
only_ Sequence[Dbnode_ weights Endpoint Read Only Node Weight Args] - read_
write_ strmode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read_
write_ intproxy_ connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write_
node_ boolhalt_ writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- enable
Read StringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Name String - Instance connection endpoint name.
- endpoint
Type String - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner
Addresses Property Map - Public service zone connection address
- instance
Id String - Instance ID.
- nodes String
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private
Addresses Property Map - Private network connection address
- public
Addresses Property Map - Public network connection address
- read
Only StringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read
Only NumberNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read
Only List<Property Map>Node Weights - read
Write StringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read
Write NumberProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write
Node BooleanHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
Outputs
All input properties are implicitly available as output properties. Additionally, the DbEndpoint resource produces the following output properties:
- Auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- Description string
- Address description
- Enable
Read stringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- Endpoint
Id string - Instance connection endpoint ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- Description string
- Address description
- Enable
Read stringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- Endpoint
Id string - Instance connection endpoint ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- auto_
add_ stringnew_ nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description string
- Address description
- enable_
read_ stringonly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- endpoint_
id string - Instance connection endpoint ID.
- id string
- The provider-assigned unique ID for this managed resource.
- auto
Add StringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description String
- Address description
- enable
Read StringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- endpoint
Id String - Instance connection endpoint ID.
- id String
- The provider-assigned unique ID for this managed resource.
- auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description string
- Address description
- enable
Read stringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- endpoint
Id string - Instance connection endpoint ID.
- id string
- The provider-assigned unique ID for this managed resource.
- auto_
add_ strnew_ nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description str
- Address description
- enable_
read_ stronly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- endpoint_
id str - Instance connection endpoint ID.
- id str
- The provider-assigned unique ID for this managed resource.
- auto
Add StringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description String
- Address description
- enable
Read StringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- endpoint
Id String - Instance connection endpoint 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,
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,
inner_addresses: Optional[DbEndpointInnerAddressesArgs] = None,
instance_id: Optional[str] = None,
nodes: Optional[str] = None,
private_addresses: Optional[DbEndpointPrivateAddressesArgs] = None,
public_addresses: Optional[DbEndpointPublicAddressesArgs] = 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) -> DbEndpointfunc 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: bytepluscc:rdspostgresql:DbEndpoint get: id: ${id}import {
to = bytepluscc_rdspostgresql_dbendpoint.example
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.
- Auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- Description string
- Address description
- Enable
Read stringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- Enable
Read stringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- Endpoint
Id string - Instance connection endpoint ID.
- Endpoint
Name string - Instance connection endpoint name.
- Endpoint
Type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- Inner
Addresses Byteplus.Db Endpoint Inner Addresses - Public service zone connection address
- Instance
Id string - Instance ID.
- Nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- Private
Addresses Byteplus.Db Endpoint Private Addresses - Private network connection address
- Public
Addresses Byteplus.Db Endpoint Public Addresses - Public network connection address
- Read
Only stringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- Read
Only intNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- Read
Only List<Byteplus.Node Weights Db Endpoint Read Only Node Weight> - Read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- Read
Write intProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- Write
Node boolHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- Auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- Description string
- Address description
- Enable
Read stringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- Enable
Read stringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- Endpoint
Id string - Instance connection endpoint ID.
- Endpoint
Name string - Instance connection endpoint name.
- Endpoint
Type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- Inner
Addresses DbEndpoint Inner Addresses Args - Public service zone connection address
- Instance
Id string - Instance ID.
- Nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- Private
Addresses DbEndpoint Private Addresses Args - Private network connection address
- Public
Addresses DbEndpoint Public Addresses Args - Public network connection address
- Read
Only stringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- Read
Only intNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- Read
Only []DbNode Weights Endpoint Read Only Node Weight Args - Read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- Read
Write intProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- Write
Node boolHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- auto_
add_ stringnew_ nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description string
- Address description
- enable_
read_ stringonly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- enable_
read_ stringwrite_ splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint_
id string - Instance connection endpoint ID.
- endpoint_
name string - Instance connection endpoint name.
- endpoint_
type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner_
addresses object - Public service zone connection address
- instance_
id string - Instance ID.
- nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private_
addresses object - Private network connection address
- public_
addresses object - Public network connection address
- read_
only_ stringnode_ distribution_ type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read_
only_ numbernode_ max_ delay_ time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read_
only_ list(object)node_ weights - read_
write_ stringmode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read_
write_ numberproxy_ connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write_
node_ boolhalt_ writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- auto
Add StringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description String
- Address description
- enable
Read StringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- enable
Read StringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Id String - Instance connection endpoint ID.
- endpoint
Name String - Instance connection endpoint name.
- endpoint
Type String - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner
Addresses DbEndpoint Inner Addresses - Public service zone connection address
- instance
Id String - Instance ID.
- nodes String
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private
Addresses DbEndpoint Private Addresses - Private network connection address
- public
Addresses DbEndpoint Public Addresses - Public network connection address
- read
Only StringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read
Only IntegerNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read
Only List<DbNode Weights Endpoint Read Only Node Weight> - read
Write StringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read
Write IntegerProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write
Node BooleanHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description string
- Address description
- enable
Read stringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- enable
Read stringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Id string - Instance connection endpoint ID.
- endpoint
Name string - Instance connection endpoint name.
- endpoint
Type string - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner
Addresses DbEndpoint Inner Addresses - Public service zone connection address
- instance
Id string - Instance ID.
- nodes string
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private
Addresses DbEndpoint Private Addresses - Private network connection address
- public
Addresses DbEndpoint Public Addresses - Public network connection address
- read
Only stringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read
Only numberNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read
Only DbNode Weights Endpoint Read Only Node Weight[] - read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read
Write numberProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write
Node booleanHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- auto_
add_ strnew_ nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description str
- Address description
- enable_
read_ stronly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- enable_
read_ strwrite_ splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint_
id str - Instance connection endpoint ID.
- endpoint_
name str - Instance connection endpoint name.
- endpoint_
type str - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner_
addresses DbEndpoint Inner Addresses Args - Public service zone connection address
- instance_
id str - Instance ID.
- nodes str
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private_
addresses DbEndpoint Private Addresses Args - Private network connection address
- public_
addresses DbEndpoint Public Addresses Args - Public network connection address
- read_
only_ strnode_ distribution_ type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read_
only_ intnode_ max_ delay_ time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read_
only_ Sequence[Dbnode_ weights Endpoint Read Only Node Weight Args] - read_
write_ strmode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read_
write_ intproxy_ connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write_
node_ boolhalt_ writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
- auto
Add StringNew Nodes - When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
- description String
- Address description
- enable
Read StringOnly - Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
- enable
Read StringWrite Splitting - Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Id String - Instance connection endpoint ID.
- endpoint
Name String - Instance connection endpoint name.
- endpoint
Type String - Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
- inner
Addresses Property Map - Public service zone connection address
- instance
Id String - Instance ID.
- nodes String
- List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
- private
Addresses Property Map - Private network connection address
- public
Addresses Property Map - Public network connection address
- read
Only StringNode Distribution Type - Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
- read
Only NumberNode Max Delay Time - Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
- read
Only List<Property Map>Node Weights - read
Write StringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
- read
Write NumberProxy Connection - After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
- write
Node BooleanHalt Writing - Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.
Supporting Types
DbEndpointInnerAddresses, DbEndpointInnerAddressesArgs
- Cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- Dns
Visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- Domain string
- Connection domain name
- Domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- Domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- Eip
Id string - EIP ID, valid only for Public addresses.
- Ip
Address string - IP address
- Network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- Port string
- Port number.
- Subnet
Id string - Subnet ID
- Cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- Dns
Visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- Domain string
- Connection domain name
- Domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- Domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- Eip
Id string - EIP ID, valid only for Public addresses.
- Ip
Address string - IP address
- Network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- Port string
- Port number.
- Subnet
Id string - Subnet ID
- cross_
region_ stringdomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns_
visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain string
- Connection domain name
- domain_
prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain_
visibility_ stringsetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip_
id string - EIP ID, valid only for Public addresses.
- ip_
address string - IP address
- network_
type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port string
- Port number.
- subnet_
id string - Subnet ID
- cross
Region StringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility Boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain String
- Connection domain name
- domain
Prefix String - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility StringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id String - EIP ID, valid only for Public addresses.
- ip
Address String - IP address
- network
Type String - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port String
- Port number.
- subnet
Id String - Subnet ID
- cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain string
- Connection domain name
- domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id string - EIP ID, valid only for Public addresses.
- ip
Address string - IP address
- network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port string
- Port number.
- subnet
Id string - Subnet ID
- cross_
region_ strdomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns_
visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain str
- Connection domain name
- domain_
prefix str - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain_
visibility_ strsetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip_
id str - EIP ID, valid only for Public addresses.
- ip_
address str - IP address
- network_
type str - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port str
- Port number.
- subnet_
id str - Subnet ID
- cross
Region StringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility Boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain String
- Connection domain name
- domain
Prefix String - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility StringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id String - EIP ID, valid only for Public addresses.
- ip
Address String - IP address
- network
Type String - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port String
- Port number.
- subnet
Id String - Subnet ID
DbEndpointPrivateAddresses, DbEndpointPrivateAddressesArgs
- Cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- Dns
Visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- Domain string
- Connection domain name
- Domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- Domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- Eip
Id string - EIP ID, valid only for Public addresses.
- Ip
Address string - IP address
- Network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- Port string
- Port number.
- Subnet
Id string - Subnet ID
- Cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- Dns
Visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- Domain string
- Connection domain name
- Domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- Domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- Eip
Id string - EIP ID, valid only for Public addresses.
- Ip
Address string - IP address
- Network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- Port string
- Port number.
- Subnet
Id string - Subnet ID
- cross_
region_ stringdomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns_
visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain string
- Connection domain name
- domain_
prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain_
visibility_ stringsetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip_
id string - EIP ID, valid only for Public addresses.
- ip_
address string - IP address
- network_
type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port string
- Port number.
- subnet_
id string - Subnet ID
- cross
Region StringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility Boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain String
- Connection domain name
- domain
Prefix String - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility StringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id String - EIP ID, valid only for Public addresses.
- ip
Address String - IP address
- network
Type String - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port String
- Port number.
- subnet
Id String - Subnet ID
- cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain string
- Connection domain name
- domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id string - EIP ID, valid only for Public addresses.
- ip
Address string - IP address
- network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port string
- Port number.
- subnet
Id string - Subnet ID
- cross_
region_ strdomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns_
visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain str
- Connection domain name
- domain_
prefix str - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain_
visibility_ strsetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip_
id str - EIP ID, valid only for Public addresses.
- ip_
address str - IP address
- network_
type str - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port str
- Port number.
- subnet_
id str - Subnet ID
- cross
Region StringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility Boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain String
- Connection domain name
- domain
Prefix String - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility StringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id String - EIP ID, valid only for Public addresses.
- ip
Address String - IP address
- network
Type String - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port String
- Port number.
- subnet
Id String - Subnet ID
DbEndpointPublicAddresses, DbEndpointPublicAddressesArgs
- Cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- Dns
Visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- Domain string
- Connection domain name
- Domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- Domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- Eip
Id string - EIP ID, valid only for Public addresses.
- Ip
Address string - IP address
- Network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- Port string
- Port number.
- Subnet
Id string - Subnet ID
- Cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- Dns
Visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- Domain string
- Connection domain name
- Domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- Domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- Eip
Id string - EIP ID, valid only for Public addresses.
- Ip
Address string - IP address
- Network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- Port string
- Port number.
- Subnet
Id string - Subnet ID
- cross_
region_ stringdomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns_
visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain string
- Connection domain name
- domain_
prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain_
visibility_ stringsetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip_
id string - EIP ID, valid only for Public addresses.
- ip_
address string - IP address
- network_
type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port string
- Port number.
- subnet_
id string - Subnet ID
- cross
Region StringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility Boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain String
- Connection domain name
- domain
Prefix String - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility StringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id String - EIP ID, valid only for Public addresses.
- ip
Address String - IP address
- network
Type String - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port String
- Port number.
- subnet
Id String - Subnet ID
- cross
Region stringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain string
- Connection domain name
- domain
Prefix string - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility stringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id string - EIP ID, valid only for Public addresses.
- ip
Address string - IP address
- network
Type string - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port string
- Port number.
- subnet
Id string - Subnet ID
- cross_
region_ strdomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns_
visibility bool - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain str
- Connection domain name
- domain_
prefix str - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain_
visibility_ strsetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip_
id str - EIP ID, valid only for Public addresses.
- ip_
address str - IP address
- network_
type str - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port str
- Port number.
- subnet_
id str - Subnet ID
- cross
Region StringDomain - Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
- dns
Visibility Boolean - Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
- domain String
- Connection domain name
- domain
Prefix String - New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
- domain
Visibility StringSetting - Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
- eip
Id String - EIP ID, valid only for Public addresses.
- ip
Address String - IP address
- network
Type String - Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
- port String
- Port number.
- subnet
Id String - Subnet ID
DbEndpointReadOnlyNodeWeight, DbEndpointReadOnlyNodeWeightArgs
Import
$ pulumi import bytepluscc:rdspostgresql/dbEndpoint:DbEndpoint example "instance_id|endpoint_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
published on Monday, May 25, 2026 by Byteplus