Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vedb_mysql
  5. Endpoints
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.vedb_mysql.Endpoints

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of vedb mysql endpoints

    Example Usage

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

const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[2]?.id),
    vpcId: fooVpc.id,
});
const fooInstance = new volcengine.vedb_mysql.Instance("fooInstance", {
    chargeType: "PostPaid",
    storageChargeType: "PostPaid",
    dbEngineVersion: "MySQL_8_0",
    dbMinorVersion: "3.0",
    nodeNumber: 2,
    nodeSpec: "vedb.mysql.x4.large",
    subnetId: fooSubnet.id,
    instanceName: "tf-test",
    projectName: "testA",
    tags: [
        {
            key: "tftest",
            value: "tftest",
        },
        {
            key: "tftest2",
            value: "tftest2",
        },
    ],
});
const fooInstances = volcengine.vedb_mysql.InstancesOutput({
    instanceId: fooInstance.id,
});
const fooEndpoint = new volcengine.vedb_mysql.Endpoint("fooEndpoint", {
    endpointType: "Custom",
    instanceId: fooInstance.id,
    nodeIds: [
        fooInstances.apply(fooInstances => fooInstances.instances?.[0]?.nodes?.[0]?.nodeId),
        fooInstances.apply(fooInstances => fooInstances.instances?.[0]?.nodes?.[1]?.nodeId),
    ],
    readWriteMode: "ReadWrite",
    endpointName: "tf-test",
    description: "tf test",
    masterAcceptReadRequests: true,
    distributedTransaction: true,
    consistLevel: "Session",
    consistTimeout: 100000,
    consistTimeoutAction: "ReadMaster",
});
const fooEndpoints = volcengine.vedb_mysql.EndpointsOutput({
    endpointId: fooEndpoint.endpointId,
    instanceId: fooInstance.id,
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[2].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.vedb_mysql.Instance("fooInstance",
    charge_type="PostPaid",
    storage_charge_type="PostPaid",
    db_engine_version="MySQL_8_0",
    db_minor_version="3.0",
    node_number=2,
    node_spec="vedb.mysql.x4.large",
    subnet_id=foo_subnet.id,
    instance_name="tf-test",
    project_name="testA",
    tags=[
        volcengine.vedb_mysql.InstanceTagArgs(
            key="tftest",
            value="tftest",
        ),
        volcengine.vedb_mysql.InstanceTagArgs(
            key="tftest2",
            value="tftest2",
        ),
    ])
foo_instances = volcengine.vedb_mysql.instances_output(instance_id=foo_instance.id)
foo_endpoint = volcengine.vedb_mysql.Endpoint("fooEndpoint",
    endpoint_type="Custom",
    instance_id=foo_instance.id,
    node_ids=[
        foo_instances.instances[0].nodes[0].node_id,
        foo_instances.instances[0].nodes[1].node_id,
    ],
    read_write_mode="ReadWrite",
    endpoint_name="tf-test",
    description="tf test",
    master_accept_read_requests=True,
    distributed_transaction=True,
    consist_level="Session",
    consist_timeout=100000,
    consist_timeout_action="ReadMaster")
foo_endpoints = volcengine.vedb_mysql.endpoints_output(endpoint_id=foo_endpoint.endpoint_id,
    instance_id=foo_instance.id)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vedb_mysql"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[2].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooInstance, err := vedb_mysql.NewInstance(ctx, "fooInstance", &vedb_mysql.InstanceArgs{
			ChargeType:        pulumi.String("PostPaid"),
			StorageChargeType: pulumi.String("PostPaid"),
			DbEngineVersion:   pulumi.String("MySQL_8_0"),
			DbMinorVersion:    pulumi.String("3.0"),
			NodeNumber:        pulumi.Int(2),
			NodeSpec:          pulumi.String("vedb.mysql.x4.large"),
			SubnetId:          fooSubnet.ID(),
			InstanceName:      pulumi.String("tf-test"),
			ProjectName:       pulumi.String("testA"),
			Tags: vedb_mysql.InstanceTagArray{
				&vedb_mysql.InstanceTagArgs{
					Key:   pulumi.String("tftest"),
					Value: pulumi.String("tftest"),
				},
				&vedb_mysql.InstanceTagArgs{
					Key:   pulumi.String("tftest2"),
					Value: pulumi.String("tftest2"),
				},
			},
		})
		if err != nil {
			return err
		}
		fooInstances := vedb_mysql.InstancesOutput(ctx, vedb_mysql.InstancesOutputArgs{
			InstanceId: fooInstance.ID(),
		}, nil)
		fooEndpoint, err := vedb_mysql.NewEndpoint(ctx, "fooEndpoint", &vedb_mysql.EndpointArgs{
			EndpointType: pulumi.String("Custom"),
			InstanceId:   fooInstance.ID(),
			NodeIds: pulumi.StringArray{
				fooInstances.ApplyT(func(fooInstances vedb_mysql.InstancesResult) (*string, error) {
					return &fooInstances.Instances[0].Nodes[0].NodeId, nil
				}).(pulumi.StringPtrOutput),
				fooInstances.ApplyT(func(fooInstances vedb_mysql.InstancesResult) (*string, error) {
					return &fooInstances.Instances[0].Nodes[1].NodeId, nil
				}).(pulumi.StringPtrOutput),
			},
			ReadWriteMode:            pulumi.String("ReadWrite"),
			EndpointName:             pulumi.String("tf-test"),
			Description:              pulumi.String("tf test"),
			MasterAcceptReadRequests: pulumi.Bool(true),
			DistributedTransaction:   pulumi.Bool(true),
			ConsistLevel:             pulumi.String("Session"),
			ConsistTimeout:           pulumi.Int(100000),
			ConsistTimeoutAction:     pulumi.String("ReadMaster"),
		})
		if err != nil {
			return err
		}
		_ = vedb_mysql.EndpointsOutput(ctx, vedb_mysql.EndpointsOutputArgs{
			EndpointId: fooEndpoint.EndpointId,
			InstanceId: fooInstance.ID(),
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[2]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Vedb_mysql.Instance("fooInstance", new()
    {
        ChargeType = "PostPaid",
        StorageChargeType = "PostPaid",
        DbEngineVersion = "MySQL_8_0",
        DbMinorVersion = "3.0",
        NodeNumber = 2,
        NodeSpec = "vedb.mysql.x4.large",
        SubnetId = fooSubnet.Id,
        InstanceName = "tf-test",
        ProjectName = "testA",
        Tags = new[]
        {
            new Volcengine.Vedb_mysql.Inputs.InstanceTagArgs
            {
                Key = "tftest",
                Value = "tftest",
            },
            new Volcengine.Vedb_mysql.Inputs.InstanceTagArgs
            {
                Key = "tftest2",
                Value = "tftest2",
            },
        },
    });

    var fooInstances = Volcengine.Vedb_mysql.Instances.Invoke(new()
    {
        InstanceId = fooInstance.Id,
    });

    var fooEndpoint = new Volcengine.Vedb_mysql.Endpoint("fooEndpoint", new()
    {
        EndpointType = "Custom",
        InstanceId = fooInstance.Id,
        NodeIds = new[]
        {
            fooInstances.Apply(instancesResult => instancesResult.Instances[0]?.Nodes[0]?.NodeId),
            fooInstances.Apply(instancesResult => instancesResult.Instances[0]?.Nodes[1]?.NodeId),
        },
        ReadWriteMode = "ReadWrite",
        EndpointName = "tf-test",
        Description = "tf test",
        MasterAcceptReadRequests = true,
        DistributedTransaction = true,
        ConsistLevel = "Session",
        ConsistTimeout = 100000,
        ConsistTimeoutAction = "ReadMaster",
    });

    var fooEndpoints = Volcengine.Vedb_mysql.Endpoints.Invoke(new()
    {
        EndpointId = fooEndpoint.EndpointId,
        InstanceId = fooInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.vedb_mysql.Instance;
import com.pulumi.volcengine.vedb_mysql.InstanceArgs;
import com.pulumi.volcengine.vedb_mysql.inputs.InstanceTagArgs;
import com.pulumi.volcengine.vedb_mysql.Vedb_mysqlFunctions;
import com.pulumi.volcengine.vedb_mysql.inputs.InstancesArgs;
import com.pulumi.volcengine.vedb_mysql.Endpoint;
import com.pulumi.volcengine.vedb_mysql.EndpointArgs;
import com.pulumi.volcengine.vedb_mysql.inputs.EndpointsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[2].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .chargeType("PostPaid")
            .storageChargeType("PostPaid")
            .dbEngineVersion("MySQL_8_0")
            .dbMinorVersion("3.0")
            .nodeNumber(2)
            .nodeSpec("vedb.mysql.x4.large")
            .subnetId(fooSubnet.id())
            .instanceName("tf-test")
            .projectName("testA")
            .tags(            
                InstanceTagArgs.builder()
                    .key("tftest")
                    .value("tftest")
                    .build(),
                InstanceTagArgs.builder()
                    .key("tftest2")
                    .value("tftest2")
                    .build())
            .build());

        final var fooInstances = Vedb_mysqlFunctions.Instances(InstancesArgs.builder()
            .instanceId(fooInstance.id())
            .build());

        var fooEndpoint = new Endpoint("fooEndpoint", EndpointArgs.builder()        
            .endpointType("Custom")
            .instanceId(fooInstance.id())
            .nodeIds(            
                fooInstances.applyValue(instancesResult -> instancesResult).applyValue(fooInstances -> fooInstances.applyValue(instancesResult -> instancesResult.instances()[0].nodes()[0].nodeId())),
                fooInstances.applyValue(instancesResult -> instancesResult).applyValue(fooInstances -> fooInstances.applyValue(instancesResult -> instancesResult.instances()[0].nodes()[1].nodeId())))
            .readWriteMode("ReadWrite")
            .endpointName("tf-test")
            .description("tf test")
            .masterAcceptReadRequests(true)
            .distributedTransaction(true)
            .consistLevel("Session")
            .consistTimeout(100000)
            .consistTimeoutAction("ReadMaster")
            .build());

        final var fooEndpoints = Vedb_mysqlFunctions.Endpoints(EndpointsArgs.builder()
            .endpointId(fooEndpoint.endpointId())
            .instanceId(fooInstance.id())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[2].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:vedb_mysql:Instance
    properties:
      chargeType: PostPaid
      storageChargeType: PostPaid
      dbEngineVersion: MySQL_8_0
      dbMinorVersion: '3.0'
      nodeNumber: 2
      nodeSpec: vedb.mysql.x4.large
      subnetId: ${fooSubnet.id}
      instanceName: tf-test
      projectName: testA
      tags:
        - key: tftest
          value: tftest
        - key: tftest2
          value: tftest2
  fooEndpoint:
    type: volcengine:vedb_mysql:Endpoint
    properties:
      endpointType: Custom
      instanceId: ${fooInstance.id}
      nodeIds:
        - ${fooInstances.instances[0].nodes[0].nodeId}
        - ${fooInstances.instances[0].nodes[1].nodeId}
      readWriteMode: ReadWrite
      endpointName: tf-test
      description: tf test
      masterAcceptReadRequests: true
      distributedTransaction: true
      consistLevel: Session
      consistTimeout: 100000
      consistTimeoutAction: ReadMaster
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}
  fooInstances:
    fn::invoke:
      Function: volcengine:vedb_mysql:Instances
      Arguments:
        instanceId: ${fooInstance.id}
  fooEndpoints:
    fn::invoke:
      Function: volcengine:vedb_mysql:Endpoints
      Arguments:
        endpointId: ${fooEndpoint.endpointId}
        instanceId: ${fooInstance.id}

    Using Endpoints

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function endpoints(args: EndpointsArgs, opts?: InvokeOptions): Promise<EndpointsResult>
function endpointsOutput(args: EndpointsOutputArgs, opts?: InvokeOptions): Output<EndpointsResult>
    def endpoints(endpoint_id: Optional[str] = None,
              instance_id: Optional[str] = None,
              name_regex: Optional[str] = None,
              output_file: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> EndpointsResult
def endpoints_output(endpoint_id: Optional[pulumi.Input[str]] = None,
              instance_id: Optional[pulumi.Input[str]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[EndpointsResult]
    func Endpoints(ctx *Context, args *EndpointsArgs, opts ...InvokeOption) (*EndpointsResult, error)
func EndpointsOutput(ctx *Context, args *EndpointsOutputArgs, opts ...InvokeOption) EndpointsResultOutput
    public static class Endpoints 
{
    public static Task<EndpointsResult> InvokeAsync(EndpointsArgs args, InvokeOptions? opts = null)
    public static Output<EndpointsResult> Invoke(EndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<EndpointsResult> endpoints(EndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: volcengine:vedb_mysql:Endpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of the instance.
    EndpointId string
    The id of the endpoint.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The id of the instance.
    EndpointId string
    The id of the endpoint.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The id of the instance.
    endpointId String
    The id of the endpoint.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    instanceId string
    The id of the instance.
    endpointId string
    The id of the endpoint.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    instance_id str
    The id of the instance.
    endpoint_id str
    The id of the endpoint.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    instanceId String
    The id of the instance.
    endpointId String
    The id of the endpoint.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.

    Endpoints Result

    The following output properties are available:

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

    Supporting Types

    EndpointsEndpoint

    Addresses List<EndpointsEndpointAddress>
    The address information.
    AutoAddNewNodes bool
    Set whether newly created read-only nodes will automatically join this connection endpoint. Values: true: Automatically join. false: Do not automatically join (default).
    ConsistLevel string
    Consistency level. For detailed introduction of consistency level, please refer to consistency level. Value range: Eventual: eventual consistency. Session: session consistency. Global: global consistency. Description When the value of ReadWriteMode is ReadWrite, the selectable consistency levels are Eventual, Session (default), and Global. When the value of ReadWriteMode is ReadOnly, the consistency level is Eventual by default and cannot be changed.
    ConsistTimeout int
    When there is a large delay, the timeout period for read-only nodes to synchronize the latest data, in us. The value range is from 1us to 100000000us, and the default value is 10000us. Explanation This parameter takes effect only when the value of ConsistLevel is Global or Session.
    ConsistTimeoutAction string
    Timeout policy after data synchronization timeout of read-only nodes supports the following two policies: ReturnError: Return SQL error (wait replication complete timeout, please retry). ReadMaster: Send a request to the master node (default). Description This parameter takes effect only when the value of ConsistLevel is Global or Session.
    Description string
    Description information for connecting endpoint. The length cannot exceed 200 characters.
    DistributedTransaction bool
    Set whether to enable transaction splitting. For detailed introduction to transaction splitting, please refer to transaction splitting. Value range: true: Enabled (default). false: Disabled. Description Only when the value of ReadWriteMode is ReadWrite, is enabling transaction splitting supported.
    EndpointId string
    The id of the endpoint.
    EndpointName string
    Connect the endpoint name. The setting rules are as follows: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length is 1 to 64 characters.
    EndpointType string
    Connect terminal type. The value is fixed as Custom, indicating a custom terminal.
    Id string
    The id of the endpoint.
    MasterAcceptReadRequests bool
    The master node accepts read requests. Value range: true: (default) After enabling the master node to accept read functions, non-transactional read requests will be sent to the master node or read-only nodes in a load-balanced mode according to the number of active requests. false: After disabling the master node from accepting read requests, at this time, the master node only accepts transactional read requests, and non-transactional read requests will not be sent to the master node. Description Only when the value of ReadWriteMode is ReadWrite, enabling the master node to accept reads is supported.
    NodeIds List<string>
    Connect the node IDs associated with the endpoint.The filling rules are as follows: When the value of ReadWriteMode is ReadWrite, at least two nodes must be passed in, and the master node must be passed in. When the value of ReadWriteMode is ReadOnly, one or more read-only nodes can be passed in.
    ReadWriteMode string
    Endpoint read-write mode. Values: ReadWrite: Read and write terminal. ReadOnly: Read-only terminal (default).
    Addresses []EndpointsEndpointAddress
    The address information.
    AutoAddNewNodes bool
    Set whether newly created read-only nodes will automatically join this connection endpoint. Values: true: Automatically join. false: Do not automatically join (default).
    ConsistLevel string
    Consistency level. For detailed introduction of consistency level, please refer to consistency level. Value range: Eventual: eventual consistency. Session: session consistency. Global: global consistency. Description When the value of ReadWriteMode is ReadWrite, the selectable consistency levels are Eventual, Session (default), and Global. When the value of ReadWriteMode is ReadOnly, the consistency level is Eventual by default and cannot be changed.
    ConsistTimeout int
    When there is a large delay, the timeout period for read-only nodes to synchronize the latest data, in us. The value range is from 1us to 100000000us, and the default value is 10000us. Explanation This parameter takes effect only when the value of ConsistLevel is Global or Session.
    ConsistTimeoutAction string
    Timeout policy after data synchronization timeout of read-only nodes supports the following two policies: ReturnError: Return SQL error (wait replication complete timeout, please retry). ReadMaster: Send a request to the master node (default). Description This parameter takes effect only when the value of ConsistLevel is Global or Session.
    Description string
    Description information for connecting endpoint. The length cannot exceed 200 characters.
    DistributedTransaction bool
    Set whether to enable transaction splitting. For detailed introduction to transaction splitting, please refer to transaction splitting. Value range: true: Enabled (default). false: Disabled. Description Only when the value of ReadWriteMode is ReadWrite, is enabling transaction splitting supported.
    EndpointId string
    The id of the endpoint.
    EndpointName string
    Connect the endpoint name. The setting rules are as follows: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length is 1 to 64 characters.
    EndpointType string
    Connect terminal type. The value is fixed as Custom, indicating a custom terminal.
    Id string
    The id of the endpoint.
    MasterAcceptReadRequests bool
    The master node accepts read requests. Value range: true: (default) After enabling the master node to accept read functions, non-transactional read requests will be sent to the master node or read-only nodes in a load-balanced mode according to the number of active requests. false: After disabling the master node from accepting read requests, at this time, the master node only accepts transactional read requests, and non-transactional read requests will not be sent to the master node. Description Only when the value of ReadWriteMode is ReadWrite, enabling the master node to accept reads is supported.
    NodeIds []string
    Connect the node IDs associated with the endpoint.The filling rules are as follows: When the value of ReadWriteMode is ReadWrite, at least two nodes must be passed in, and the master node must be passed in. When the value of ReadWriteMode is ReadOnly, one or more read-only nodes can be passed in.
    ReadWriteMode string
    Endpoint read-write mode. Values: ReadWrite: Read and write terminal. ReadOnly: Read-only terminal (default).
    addresses List<EndpointsEndpointAddress>
    The address information.
    autoAddNewNodes Boolean
    Set whether newly created read-only nodes will automatically join this connection endpoint. Values: true: Automatically join. false: Do not automatically join (default).
    consistLevel String
    Consistency level. For detailed introduction of consistency level, please refer to consistency level. Value range: Eventual: eventual consistency. Session: session consistency. Global: global consistency. Description When the value of ReadWriteMode is ReadWrite, the selectable consistency levels are Eventual, Session (default), and Global. When the value of ReadWriteMode is ReadOnly, the consistency level is Eventual by default and cannot be changed.
    consistTimeout Integer
    When there is a large delay, the timeout period for read-only nodes to synchronize the latest data, in us. The value range is from 1us to 100000000us, and the default value is 10000us. Explanation This parameter takes effect only when the value of ConsistLevel is Global or Session.
    consistTimeoutAction String
    Timeout policy after data synchronization timeout of read-only nodes supports the following two policies: ReturnError: Return SQL error (wait replication complete timeout, please retry). ReadMaster: Send a request to the master node (default). Description This parameter takes effect only when the value of ConsistLevel is Global or Session.
    description String
    Description information for connecting endpoint. The length cannot exceed 200 characters.
    distributedTransaction Boolean
    Set whether to enable transaction splitting. For detailed introduction to transaction splitting, please refer to transaction splitting. Value range: true: Enabled (default). false: Disabled. Description Only when the value of ReadWriteMode is ReadWrite, is enabling transaction splitting supported.
    endpointId String
    The id of the endpoint.
    endpointName String
    Connect the endpoint name. The setting rules are as follows: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length is 1 to 64 characters.
    endpointType String
    Connect terminal type. The value is fixed as Custom, indicating a custom terminal.
    id String
    The id of the endpoint.
    masterAcceptReadRequests Boolean
    The master node accepts read requests. Value range: true: (default) After enabling the master node to accept read functions, non-transactional read requests will be sent to the master node or read-only nodes in a load-balanced mode according to the number of active requests. false: After disabling the master node from accepting read requests, at this time, the master node only accepts transactional read requests, and non-transactional read requests will not be sent to the master node. Description Only when the value of ReadWriteMode is ReadWrite, enabling the master node to accept reads is supported.
    nodeIds List<String>
    Connect the node IDs associated with the endpoint.The filling rules are as follows: When the value of ReadWriteMode is ReadWrite, at least two nodes must be passed in, and the master node must be passed in. When the value of ReadWriteMode is ReadOnly, one or more read-only nodes can be passed in.
    readWriteMode String
    Endpoint read-write mode. Values: ReadWrite: Read and write terminal. ReadOnly: Read-only terminal (default).
    addresses EndpointsEndpointAddress[]
    The address information.
    autoAddNewNodes boolean
    Set whether newly created read-only nodes will automatically join this connection endpoint. Values: true: Automatically join. false: Do not automatically join (default).
    consistLevel string
    Consistency level. For detailed introduction of consistency level, please refer to consistency level. Value range: Eventual: eventual consistency. Session: session consistency. Global: global consistency. Description When the value of ReadWriteMode is ReadWrite, the selectable consistency levels are Eventual, Session (default), and Global. When the value of ReadWriteMode is ReadOnly, the consistency level is Eventual by default and cannot be changed.
    consistTimeout number
    When there is a large delay, the timeout period for read-only nodes to synchronize the latest data, in us. The value range is from 1us to 100000000us, and the default value is 10000us. Explanation This parameter takes effect only when the value of ConsistLevel is Global or Session.
    consistTimeoutAction string
    Timeout policy after data synchronization timeout of read-only nodes supports the following two policies: ReturnError: Return SQL error (wait replication complete timeout, please retry). ReadMaster: Send a request to the master node (default). Description This parameter takes effect only when the value of ConsistLevel is Global or Session.
    description string
    Description information for connecting endpoint. The length cannot exceed 200 characters.
    distributedTransaction boolean
    Set whether to enable transaction splitting. For detailed introduction to transaction splitting, please refer to transaction splitting. Value range: true: Enabled (default). false: Disabled. Description Only when the value of ReadWriteMode is ReadWrite, is enabling transaction splitting supported.
    endpointId string
    The id of the endpoint.
    endpointName string
    Connect the endpoint name. The setting rules are as follows: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length is 1 to 64 characters.
    endpointType string
    Connect terminal type. The value is fixed as Custom, indicating a custom terminal.
    id string
    The id of the endpoint.
    masterAcceptReadRequests boolean
    The master node accepts read requests. Value range: true: (default) After enabling the master node to accept read functions, non-transactional read requests will be sent to the master node or read-only nodes in a load-balanced mode according to the number of active requests. false: After disabling the master node from accepting read requests, at this time, the master node only accepts transactional read requests, and non-transactional read requests will not be sent to the master node. Description Only when the value of ReadWriteMode is ReadWrite, enabling the master node to accept reads is supported.
    nodeIds string[]
    Connect the node IDs associated with the endpoint.The filling rules are as follows: When the value of ReadWriteMode is ReadWrite, at least two nodes must be passed in, and the master node must be passed in. When the value of ReadWriteMode is ReadOnly, one or more read-only nodes can be passed in.
    readWriteMode string
    Endpoint read-write mode. Values: ReadWrite: Read and write terminal. ReadOnly: Read-only terminal (default).
    addresses Sequence[EndpointsEndpointAddress]
    The address information.
    auto_add_new_nodes bool
    Set whether newly created read-only nodes will automatically join this connection endpoint. Values: true: Automatically join. false: Do not automatically join (default).
    consist_level str
    Consistency level. For detailed introduction of consistency level, please refer to consistency level. Value range: Eventual: eventual consistency. Session: session consistency. Global: global consistency. Description When the value of ReadWriteMode is ReadWrite, the selectable consistency levels are Eventual, Session (default), and Global. When the value of ReadWriteMode is ReadOnly, the consistency level is Eventual by default and cannot be changed.
    consist_timeout int
    When there is a large delay, the timeout period for read-only nodes to synchronize the latest data, in us. The value range is from 1us to 100000000us, and the default value is 10000us. Explanation This parameter takes effect only when the value of ConsistLevel is Global or Session.
    consist_timeout_action str
    Timeout policy after data synchronization timeout of read-only nodes supports the following two policies: ReturnError: Return SQL error (wait replication complete timeout, please retry). ReadMaster: Send a request to the master node (default). Description This parameter takes effect only when the value of ConsistLevel is Global or Session.
    description str
    Description information for connecting endpoint. The length cannot exceed 200 characters.
    distributed_transaction bool
    Set whether to enable transaction splitting. For detailed introduction to transaction splitting, please refer to transaction splitting. Value range: true: Enabled (default). false: Disabled. Description Only when the value of ReadWriteMode is ReadWrite, is enabling transaction splitting supported.
    endpoint_id str
    The id of the endpoint.
    endpoint_name str
    Connect the endpoint name. The setting rules are as follows: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length is 1 to 64 characters.
    endpoint_type str
    Connect terminal type. The value is fixed as Custom, indicating a custom terminal.
    id str
    The id of the endpoint.
    master_accept_read_requests bool
    The master node accepts read requests. Value range: true: (default) After enabling the master node to accept read functions, non-transactional read requests will be sent to the master node or read-only nodes in a load-balanced mode according to the number of active requests. false: After disabling the master node from accepting read requests, at this time, the master node only accepts transactional read requests, and non-transactional read requests will not be sent to the master node. Description Only when the value of ReadWriteMode is ReadWrite, enabling the master node to accept reads is supported.
    node_ids Sequence[str]
    Connect the node IDs associated with the endpoint.The filling rules are as follows: When the value of ReadWriteMode is ReadWrite, at least two nodes must be passed in, and the master node must be passed in. When the value of ReadWriteMode is ReadOnly, one or more read-only nodes can be passed in.
    read_write_mode str
    Endpoint read-write mode. Values: ReadWrite: Read and write terminal. ReadOnly: Read-only terminal (default).
    addresses List<Property Map>
    The address information.
    autoAddNewNodes Boolean
    Set whether newly created read-only nodes will automatically join this connection endpoint. Values: true: Automatically join. false: Do not automatically join (default).
    consistLevel String
    Consistency level. For detailed introduction of consistency level, please refer to consistency level. Value range: Eventual: eventual consistency. Session: session consistency. Global: global consistency. Description When the value of ReadWriteMode is ReadWrite, the selectable consistency levels are Eventual, Session (default), and Global. When the value of ReadWriteMode is ReadOnly, the consistency level is Eventual by default and cannot be changed.
    consistTimeout Number
    When there is a large delay, the timeout period for read-only nodes to synchronize the latest data, in us. The value range is from 1us to 100000000us, and the default value is 10000us. Explanation This parameter takes effect only when the value of ConsistLevel is Global or Session.
    consistTimeoutAction String
    Timeout policy after data synchronization timeout of read-only nodes supports the following two policies: ReturnError: Return SQL error (wait replication complete timeout, please retry). ReadMaster: Send a request to the master node (default). Description This parameter takes effect only when the value of ConsistLevel is Global or Session.
    description String
    Description information for connecting endpoint. The length cannot exceed 200 characters.
    distributedTransaction Boolean
    Set whether to enable transaction splitting. For detailed introduction to transaction splitting, please refer to transaction splitting. Value range: true: Enabled (default). false: Disabled. Description Only when the value of ReadWriteMode is ReadWrite, is enabling transaction splitting supported.
    endpointId String
    The id of the endpoint.
    endpointName String
    Connect the endpoint name. The setting rules are as follows: It cannot start with a number or a hyphen (-). It can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-). The length is 1 to 64 characters.
    endpointType String
    Connect terminal type. The value is fixed as Custom, indicating a custom terminal.
    id String
    The id of the endpoint.
    masterAcceptReadRequests Boolean
    The master node accepts read requests. Value range: true: (default) After enabling the master node to accept read functions, non-transactional read requests will be sent to the master node or read-only nodes in a load-balanced mode according to the number of active requests. false: After disabling the master node from accepting read requests, at this time, the master node only accepts transactional read requests, and non-transactional read requests will not be sent to the master node. Description Only when the value of ReadWriteMode is ReadWrite, enabling the master node to accept reads is supported.
    nodeIds List<String>
    Connect the node IDs associated with the endpoint.The filling rules are as follows: When the value of ReadWriteMode is ReadWrite, at least two nodes must be passed in, and the master node must be passed in. When the value of ReadWriteMode is ReadOnly, one or more read-only nodes can be passed in.
    readWriteMode String
    Endpoint read-write mode. Values: ReadWrite: Read and write terminal. ReadOnly: Read-only terminal (default).

    EndpointsEndpointAddress

    DnsVisibility bool
    Parsing method. Currently, the return value can only be false (Volcengine private network parsing).
    Domain string
    Instance intranet access domain name.
    EipId string
    The EIP id.
    IpAddress string
    IP address.
    NetworkType string
    Network type: Private: Private network VPC. Public: Public network access.
    Port string
    Instance intranet access port.
    SubnetId string
    Subnet ID. The subnet must belong to the selected availability zone. Description A subnet is an IP address block within a private network. All cloud resources in a private network must be deployed within a subnet. The subnet assigns private IP addresses to cloud resources.
    DnsVisibility bool
    Parsing method. Currently, the return value can only be false (Volcengine private network parsing).
    Domain string
    Instance intranet access domain name.
    EipId string
    The EIP id.
    IpAddress string
    IP address.
    NetworkType string
    Network type: Private: Private network VPC. Public: Public network access.
    Port string
    Instance intranet access port.
    SubnetId string
    Subnet ID. The subnet must belong to the selected availability zone. Description A subnet is an IP address block within a private network. All cloud resources in a private network must be deployed within a subnet. The subnet assigns private IP addresses to cloud resources.
    dnsVisibility Boolean
    Parsing method. Currently, the return value can only be false (Volcengine private network parsing).
    domain String
    Instance intranet access domain name.
    eipId String
    The EIP id.
    ipAddress String
    IP address.
    networkType String
    Network type: Private: Private network VPC. Public: Public network access.
    port String
    Instance intranet access port.
    subnetId String
    Subnet ID. The subnet must belong to the selected availability zone. Description A subnet is an IP address block within a private network. All cloud resources in a private network must be deployed within a subnet. The subnet assigns private IP addresses to cloud resources.
    dnsVisibility boolean
    Parsing method. Currently, the return value can only be false (Volcengine private network parsing).
    domain string
    Instance intranet access domain name.
    eipId string
    The EIP id.
    ipAddress string
    IP address.
    networkType string
    Network type: Private: Private network VPC. Public: Public network access.
    port string
    Instance intranet access port.
    subnetId string
    Subnet ID. The subnet must belong to the selected availability zone. Description A subnet is an IP address block within a private network. All cloud resources in a private network must be deployed within a subnet. The subnet assigns private IP addresses to cloud resources.
    dns_visibility bool
    Parsing method. Currently, the return value can only be false (Volcengine private network parsing).
    domain str
    Instance intranet access domain name.
    eip_id str
    The EIP id.
    ip_address str
    IP address.
    network_type str
    Network type: Private: Private network VPC. Public: Public network access.
    port str
    Instance intranet access port.
    subnet_id str
    Subnet ID. The subnet must belong to the selected availability zone. Description A subnet is an IP address block within a private network. All cloud resources in a private network must be deployed within a subnet. The subnet assigns private IP addresses to cloud resources.
    dnsVisibility Boolean
    Parsing method. Currently, the return value can only be false (Volcengine private network parsing).
    domain String
    Instance intranet access domain name.
    eipId String
    The EIP id.
    ipAddress String
    IP address.
    networkType String
    Network type: Private: Private network VPC. Public: Public network access.
    port String
    Instance intranet access port.
    subnetId String
    Subnet ID. The subnet must belong to the selected availability zone. Description A subnet is an IP address block within a private network. All cloud resources in a private network must be deployed within a subnet. The subnet assigns private IP addresses to cloud resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine