volcenginecc.vedbm.Endpoint

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  vEDBMEndpointDemo:
    type: volcenginecc:vedbm:Endpoint
    name: VEDBMEndpointDemo
    properties:
      publicAddresses:
        eip_id: eip-ij2xxxxx74o8cubosgei
      autoAddNewNodes: true
      consistLevel: Eventual
      description: this is a test
      distributedTransaction: false
      endpointName: ccapi-test-1001
      endpointType: Custom
      instanceId: vedbm-jxxxxttjdcea
      masterAcceptReadRequests: false
      nodeIds:
        - vedbm-jxxxxttjdcea-1
      readWriteMode: ReadOnly

Create Endpoint Resource

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

Constructor syntax

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_id: Optional[str] = None,
             endpoint_type: Optional[str] = None,
             node_ids: Optional[Sequence[str]] = None,
             consist_timeout_action: Optional[str] = None,
             description: Optional[str] = None,
             distributed_transaction: Optional[bool] = None,
             domain_prefix: Optional[str] = None,
             consist_timeout: Optional[int] = None,
             consist_level: Optional[str] = None,
             endpoint_name: Optional[str] = None,
             master_accept_read_requests: Optional[bool] = None,
             auto_add_new_nodes: Optional[bool] = None,
             port: Optional[str] = None,
             private_addresses: Optional[EndpointPrivateAddressesArgs] = None,
             public_addresses: Optional[EndpointPublicAddressesArgs] = None,
             read_write_mode: Optional[str] = None)

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

type: volcenginecc:vedbm:Endpoint
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 EndpointArgs: 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 EndpointArgs: 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 EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

InstanceId string: Instance ID
AutoAddNewNodes bool: Whether new read-only nodes are automatically added to this terminal
ConsistLevel string: Consistency level
ConsistTimeout int: Data synchronization timeout
ConsistTimeoutAction string: Policy after synchronization timeout
Description string: Description of the connection terminal
DistributedTransaction bool: Enable transaction splitting
DomainPrefix string: New private network address prefix
EndpointName string: Connection terminal name
EndpointType string: Connection terminal type, fixed as Custom
MasterAcceptReadRequests bool: Whether the primary node accepts read requests
NodeIds List<string>: Node list configured for the connection terminal
Port string: Instance access port
PrivateAddresses Volcengine.EndpointPrivateAddresses: Private address information
PublicAddresses Volcengine.EndpointPublicAddresses: Public address information
ReadWriteMode string: Terminal read/write mode

InstanceId string: Instance ID
AutoAddNewNodes bool: Whether new read-only nodes are automatically added to this terminal
ConsistLevel string: Consistency level
ConsistTimeout int: Data synchronization timeout
ConsistTimeoutAction string: Policy after synchronization timeout
Description string: Description of the connection terminal
DistributedTransaction bool: Enable transaction splitting
DomainPrefix string: New private network address prefix
EndpointName string: Connection terminal name
EndpointType string: Connection terminal type, fixed as Custom
MasterAcceptReadRequests bool: Whether the primary node accepts read requests
NodeIds []string: Node list configured for the connection terminal
Port string: Instance access port
PrivateAddresses EndpointPrivateAddressesArgs: Private address information
PublicAddresses EndpointPublicAddressesArgs: Public address information
ReadWriteMode string: Terminal read/write mode

instanceId String: Instance ID
autoAddNewNodes Boolean: Whether new read-only nodes are automatically added to this terminal
consistLevel String: Consistency level
consistTimeout Integer: Data synchronization timeout
consistTimeoutAction String: Policy after synchronization timeout
description String: Description of the connection terminal
distributedTransaction Boolean: Enable transaction splitting
domainPrefix String: New private network address prefix
endpointName String: Connection terminal name
endpointType String: Connection terminal type, fixed as Custom
masterAcceptReadRequests Boolean: Whether the primary node accepts read requests
nodeIds List<String>: Node list configured for the connection terminal
port String: Instance access port
privateAddresses EndpointPrivateAddresses: Private address information
publicAddresses EndpointPublicAddresses: Public address information
readWriteMode String: Terminal read/write mode

instanceId string: Instance ID
autoAddNewNodes boolean: Whether new read-only nodes are automatically added to this terminal
consistLevel string: Consistency level
consistTimeout number: Data synchronization timeout
consistTimeoutAction string: Policy after synchronization timeout
description string: Description of the connection terminal
distributedTransaction boolean: Enable transaction splitting
domainPrefix string: New private network address prefix
endpointName string: Connection terminal name
endpointType string: Connection terminal type, fixed as Custom
masterAcceptReadRequests boolean: Whether the primary node accepts read requests
nodeIds string[]: Node list configured for the connection terminal
port string: Instance access port
privateAddresses EndpointPrivateAddresses: Private address information
publicAddresses EndpointPublicAddresses: Public address information
readWriteMode string: Terminal read/write mode

instance_id str: Instance ID
auto_add_new_nodes bool: Whether new read-only nodes are automatically added to this terminal
consist_level str: Consistency level
consist_timeout int: Data synchronization timeout
consist_timeout_action str: Policy after synchronization timeout
description str: Description of the connection terminal
distributed_transaction bool: Enable transaction splitting
domain_prefix str: New private network address prefix
endpoint_name str: Connection terminal name
endpoint_type str: Connection terminal type, fixed as Custom
master_accept_read_requests bool: Whether the primary node accepts read requests
node_ids Sequence[str]: Node list configured for the connection terminal
port str: Instance access port
private_addresses EndpointPrivateAddressesArgs: Private address information
public_addresses EndpointPublicAddressesArgs: Public address information
read_write_mode str: Terminal read/write mode

instanceId String: Instance ID
autoAddNewNodes Boolean: Whether new read-only nodes are automatically added to this terminal
consistLevel String: Consistency level
consistTimeout Number: Data synchronization timeout
consistTimeoutAction String: Policy after synchronization timeout
description String: Description of the connection terminal
distributedTransaction Boolean: Enable transaction splitting
domainPrefix String: New private network address prefix
endpointName String: Connection terminal name
endpointType String: Connection terminal type, fixed as Custom
masterAcceptReadRequests Boolean: Whether the primary node accepts read requests
nodeIds List<String>: Node list configured for the connection terminal
port String: Instance access port
privateAddresses Property Map: Private address information
publicAddresses Property Map: Public address information
readWriteMode String: Terminal read/write mode

Outputs

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

EndpointId string: ID of the created connection terminal
Id string: The provider-assigned unique ID for this managed resource.

EndpointId string: ID of the created connection terminal
Id string: The provider-assigned unique ID for this managed resource.

endpointId String: ID of the created connection terminal
id String: The provider-assigned unique ID for this managed resource.

endpointId string: ID of the created connection terminal
id string: The provider-assigned unique ID for this managed resource.

endpoint_id str: ID of the created connection terminal
id str: The provider-assigned unique ID for this managed resource.

endpointId String: ID of the created connection terminal
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Endpoint Resource

Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_add_new_nodes: Optional[bool] = None,
        consist_level: Optional[str] = None,
        consist_timeout: Optional[int] = None,
        consist_timeout_action: Optional[str] = None,
        description: Optional[str] = None,
        distributed_transaction: Optional[bool] = None,
        domain_prefix: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        master_accept_read_requests: Optional[bool] = None,
        node_ids: Optional[Sequence[str]] = None,
        port: Optional[str] = None,
        private_addresses: Optional[EndpointPrivateAddressesArgs] = None,
        public_addresses: Optional[EndpointPublicAddressesArgs] = None,
        read_write_mode: Optional[str] = None) -> Endpoint

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)

public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:vedbm:Endpoint    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:

AutoAddNewNodes bool: Whether new read-only nodes are automatically added to this terminal
ConsistLevel string: Consistency level
ConsistTimeout int: Data synchronization timeout
ConsistTimeoutAction string: Policy after synchronization timeout
Description string: Description of the connection terminal
DistributedTransaction bool: Enable transaction splitting
DomainPrefix string: New private network address prefix
EndpointId string: ID of the created connection terminal
EndpointName string: Connection terminal name
EndpointType string: Connection terminal type, fixed as Custom
InstanceId string: Instance ID
MasterAcceptReadRequests bool: Whether the primary node accepts read requests
NodeIds List<string>: Node list configured for the connection terminal
Port string: Instance access port
PrivateAddresses Volcengine.EndpointPrivateAddresses: Private address information
PublicAddresses Volcengine.EndpointPublicAddresses: Public address information
ReadWriteMode string: Terminal read/write mode

AutoAddNewNodes bool: Whether new read-only nodes are automatically added to this terminal
ConsistLevel string: Consistency level
ConsistTimeout int: Data synchronization timeout
ConsistTimeoutAction string: Policy after synchronization timeout
Description string: Description of the connection terminal
DistributedTransaction bool: Enable transaction splitting
DomainPrefix string: New private network address prefix
EndpointId string: ID of the created connection terminal
EndpointName string: Connection terminal name
EndpointType string: Connection terminal type, fixed as Custom
InstanceId string: Instance ID
MasterAcceptReadRequests bool: Whether the primary node accepts read requests
NodeIds []string: Node list configured for the connection terminal
Port string: Instance access port
PrivateAddresses EndpointPrivateAddressesArgs: Private address information
PublicAddresses EndpointPublicAddressesArgs: Public address information
ReadWriteMode string: Terminal read/write mode

autoAddNewNodes Boolean: Whether new read-only nodes are automatically added to this terminal
consistLevel String: Consistency level
consistTimeout Integer: Data synchronization timeout
consistTimeoutAction String: Policy after synchronization timeout
description String: Description of the connection terminal
distributedTransaction Boolean: Enable transaction splitting
domainPrefix String: New private network address prefix
endpointId String: ID of the created connection terminal
endpointName String: Connection terminal name
endpointType String: Connection terminal type, fixed as Custom
instanceId String: Instance ID
masterAcceptReadRequests Boolean: Whether the primary node accepts read requests
nodeIds List<String>: Node list configured for the connection terminal
port String: Instance access port
privateAddresses EndpointPrivateAddresses: Private address information
publicAddresses EndpointPublicAddresses: Public address information
readWriteMode String: Terminal read/write mode

autoAddNewNodes boolean: Whether new read-only nodes are automatically added to this terminal
consistLevel string: Consistency level
consistTimeout number: Data synchronization timeout
consistTimeoutAction string: Policy after synchronization timeout
description string: Description of the connection terminal
distributedTransaction boolean: Enable transaction splitting
domainPrefix string: New private network address prefix
endpointId string: ID of the created connection terminal
endpointName string: Connection terminal name
endpointType string: Connection terminal type, fixed as Custom
instanceId string: Instance ID
masterAcceptReadRequests boolean: Whether the primary node accepts read requests
nodeIds string[]: Node list configured for the connection terminal
port string: Instance access port
privateAddresses EndpointPrivateAddresses: Private address information
publicAddresses EndpointPublicAddresses: Public address information
readWriteMode string: Terminal read/write mode

auto_add_new_nodes bool: Whether new read-only nodes are automatically added to this terminal
consist_level str: Consistency level
consist_timeout int: Data synchronization timeout
consist_timeout_action str: Policy after synchronization timeout
description str: Description of the connection terminal
distributed_transaction bool: Enable transaction splitting
domain_prefix str: New private network address prefix
endpoint_id str: ID of the created connection terminal
endpoint_name str: Connection terminal name
endpoint_type str: Connection terminal type, fixed as Custom
instance_id str: Instance ID
master_accept_read_requests bool: Whether the primary node accepts read requests
node_ids Sequence[str]: Node list configured for the connection terminal
port str: Instance access port
private_addresses EndpointPrivateAddressesArgs: Private address information
public_addresses EndpointPublicAddressesArgs: Public address information
read_write_mode str: Terminal read/write mode

autoAddNewNodes Boolean: Whether new read-only nodes are automatically added to this terminal
consistLevel String: Consistency level
consistTimeout Number: Data synchronization timeout
consistTimeoutAction String: Policy after synchronization timeout
description String: Description of the connection terminal
distributedTransaction Boolean: Enable transaction splitting
domainPrefix String: New private network address prefix
endpointId String: ID of the created connection terminal
endpointName String: Connection terminal name
endpointType String: Connection terminal type, fixed as Custom
instanceId String: Instance ID
masterAcceptReadRequests Boolean: Whether the primary node accepts read requests
nodeIds List<String>: Node list configured for the connection terminal
port String: Instance access port
privateAddresses Property Map: Private address information
publicAddresses Property Map: Public address information
readWriteMode String: Terminal read/write mode

Supporting Types

EndpointPrivateAddresses, EndpointPrivateAddressesArgs

DnsVisibility bool: Resolution method, fixed as false
Domain string: Instance intranet access domain name
EipId string: Public network ID
IpAddress string: IP address
NetworkType string: Network type
SubnetId string: Subnet ID

DnsVisibility bool: Resolution method, fixed as false
Domain string: Instance intranet access domain name
EipId string: Public network ID
IpAddress string: IP address
NetworkType string: Network type
SubnetId string: Subnet ID

dnsVisibility Boolean: Resolution method, fixed as false
domain String: Instance intranet access domain name
eipId String: Public network ID
ipAddress String: IP address
networkType String: Network type
subnetId String: Subnet ID

dnsVisibility boolean: Resolution method, fixed as false
domain string: Instance intranet access domain name
eipId string: Public network ID
ipAddress string: IP address
networkType string: Network type
subnetId string: Subnet ID

dns_visibility bool: Resolution method, fixed as false
domain str: Instance intranet access domain name
eip_id str: Public network ID
ip_address str: IP address
network_type str: Network type
subnet_id str: Subnet ID

dnsVisibility Boolean: Resolution method, fixed as false
domain String: Instance intranet access domain name
eipId String: Public network ID
ipAddress String: IP address
networkType String: Network type
subnetId String: Subnet ID

EndpointPublicAddresses, EndpointPublicAddressesArgs

DnsVisibility bool: Resolution method, fixed as false
Domain string: Instance intranet access domain name
EipId string: Public network ID
IpAddress string: IP address
NetworkType string: Network type
SubnetId string: Subnet ID

DnsVisibility bool: Resolution method, fixed as false
Domain string: Instance intranet access domain name
EipId string: Public network ID
IpAddress string: IP address
NetworkType string: Network type
SubnetId string: Subnet ID

dnsVisibility Boolean: Resolution method, fixed as false
domain String: Instance intranet access domain name
eipId String: Public network ID
ipAddress String: IP address
networkType String: Network type
subnetId String: Subnet ID

dnsVisibility boolean: Resolution method, fixed as false
domain string: Instance intranet access domain name
eipId string: Public network ID
ipAddress string: IP address
networkType string: Network type
subnetId string: Subnet ID

dns_visibility bool: Resolution method, fixed as false
domain str: Instance intranet access domain name
eip_id str: Public network ID
ip_address str: IP address
network_type str: Network type
subnet_id str: Subnet ID

dnsVisibility Boolean: Resolution method, fixed as false
domain String: Instance intranet access domain name
eipId String: Public network ID
ipAddress String: IP address
networkType String: Network type
subnetId String: Subnet ID

Import

$ pulumi import volcenginecc:vedbm/endpoint:Endpoint 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.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.vedbm.Endpoint

On this page

On this page

Example Usage

Create Endpoint Resource

Constructor syntax

Parameters

Endpoint Resource Properties

Inputs

Outputs

Look up Existing Endpoint Resource

Supporting Types

EndpointPrivateAddresses, EndpointPrivateAddressesArgs

EndpointPublicAddresses, EndpointPublicAddressesArgs

Import

Package Details

On this page

On this page