1. Packages
  2. Packages
  3. Tencentcloud Provider
  4. API Docs
  5. MysqlProxyAddressConfig
Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack
Viewing docs for tencentcloud 1.82.93
published on Monday, May 11, 2026 by tencentcloudstack

    Provides a resource to manage MySQL database proxy address configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const example = new tencentcloud.MysqlProxyAddressConfig("example", {
        instanceId: "cdb-o2t7gmjl",
        proxyGroupId: "proxy-ov7dqp8n",
        proxyAddressId: "proxyaddr-y8dnlfs0",
        weightMode: "system",
        isKickOut: true,
        minCount: 0,
        maxDelay: 10,
        failOver: true,
        autoAddRo: true,
        readOnly: false,
        transSplit: false,
        connectionPool: true,
        autoLoadBalance: true,
        accessMode: "nearby",
        proxyAllocations: [
            {
                region: "ap-guangzhou",
                zone: "ap-guangzhou-6",
                proxyInstances: [{
                    instanceId: "cdb-o2t7gmjl",
                    weight: 0,
                }],
            },
            {
                region: "ap-guangzhou",
                zone: "ap-guangzhou-7",
                proxyInstances: [{
                    instanceId: "cdb-o2t7gmjl",
                    weight: 0,
                }],
            },
        ],
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    example = tencentcloud.MysqlProxyAddressConfig("example",
        instance_id="cdb-o2t7gmjl",
        proxy_group_id="proxy-ov7dqp8n",
        proxy_address_id="proxyaddr-y8dnlfs0",
        weight_mode="system",
        is_kick_out=True,
        min_count=0,
        max_delay=10,
        fail_over=True,
        auto_add_ro=True,
        read_only=False,
        trans_split=False,
        connection_pool=True,
        auto_load_balance=True,
        access_mode="nearby",
        proxy_allocations=[
            {
                "region": "ap-guangzhou",
                "zone": "ap-guangzhou-6",
                "proxy_instances": [{
                    "instance_id": "cdb-o2t7gmjl",
                    "weight": 0,
                }],
            },
            {
                "region": "ap-guangzhou",
                "zone": "ap-guangzhou-7",
                "proxy_instances": [{
                    "instance_id": "cdb-o2t7gmjl",
                    "weight": 0,
                }],
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tencentcloud.NewMysqlProxyAddressConfig(ctx, "example", &tencentcloud.MysqlProxyAddressConfigArgs{
    			InstanceId:      pulumi.String("cdb-o2t7gmjl"),
    			ProxyGroupId:    pulumi.String("proxy-ov7dqp8n"),
    			ProxyAddressId:  pulumi.String("proxyaddr-y8dnlfs0"),
    			WeightMode:      pulumi.String("system"),
    			IsKickOut:       pulumi.Bool(true),
    			MinCount:        pulumi.Float64(0),
    			MaxDelay:        pulumi.Float64(10),
    			FailOver:        pulumi.Bool(true),
    			AutoAddRo:       pulumi.Bool(true),
    			ReadOnly:        pulumi.Bool(false),
    			TransSplit:      pulumi.Bool(false),
    			ConnectionPool:  pulumi.Bool(true),
    			AutoLoadBalance: pulumi.Bool(true),
    			AccessMode:      pulumi.String("nearby"),
    			ProxyAllocations: tencentcloud.MysqlProxyAddressConfigProxyAllocationArray{
    				&tencentcloud.MysqlProxyAddressConfigProxyAllocationArgs{
    					Region: pulumi.String("ap-guangzhou"),
    					Zone:   pulumi.String("ap-guangzhou-6"),
    					ProxyInstances: tencentcloud.MysqlProxyAddressConfigProxyAllocationProxyInstanceArray{
    						&tencentcloud.MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs{
    							InstanceId: pulumi.String("cdb-o2t7gmjl"),
    							Weight:     pulumi.Float64(0),
    						},
    					},
    				},
    				&tencentcloud.MysqlProxyAddressConfigProxyAllocationArgs{
    					Region: pulumi.String("ap-guangzhou"),
    					Zone:   pulumi.String("ap-guangzhou-7"),
    					ProxyInstances: tencentcloud.MysqlProxyAddressConfigProxyAllocationProxyInstanceArray{
    						&tencentcloud.MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs{
    							InstanceId: pulumi.String("cdb-o2t7gmjl"),
    							Weight:     pulumi.Float64(0),
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Tencentcloud.MysqlProxyAddressConfig("example", new()
        {
            InstanceId = "cdb-o2t7gmjl",
            ProxyGroupId = "proxy-ov7dqp8n",
            ProxyAddressId = "proxyaddr-y8dnlfs0",
            WeightMode = "system",
            IsKickOut = true,
            MinCount = 0,
            MaxDelay = 10,
            FailOver = true,
            AutoAddRo = true,
            ReadOnly = false,
            TransSplit = false,
            ConnectionPool = true,
            AutoLoadBalance = true,
            AccessMode = "nearby",
            ProxyAllocations = new[]
            {
                new Tencentcloud.Inputs.MysqlProxyAddressConfigProxyAllocationArgs
                {
                    Region = "ap-guangzhou",
                    Zone = "ap-guangzhou-6",
                    ProxyInstances = new[]
                    {
                        new Tencentcloud.Inputs.MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs
                        {
                            InstanceId = "cdb-o2t7gmjl",
                            Weight = 0,
                        },
                    },
                },
                new Tencentcloud.Inputs.MysqlProxyAddressConfigProxyAllocationArgs
                {
                    Region = "ap-guangzhou",
                    Zone = "ap-guangzhou-7",
                    ProxyInstances = new[]
                    {
                        new Tencentcloud.Inputs.MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs
                        {
                            InstanceId = "cdb-o2t7gmjl",
                            Weight = 0,
                        },
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.MysqlProxyAddressConfig;
    import com.pulumi.tencentcloud.MysqlProxyAddressConfigArgs;
    import com.pulumi.tencentcloud.inputs.MysqlProxyAddressConfigProxyAllocationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new MysqlProxyAddressConfig("example", MysqlProxyAddressConfigArgs.builder()
                .instanceId("cdb-o2t7gmjl")
                .proxyGroupId("proxy-ov7dqp8n")
                .proxyAddressId("proxyaddr-y8dnlfs0")
                .weightMode("system")
                .isKickOut(true)
                .minCount(0.0)
                .maxDelay(10.0)
                .failOver(true)
                .autoAddRo(true)
                .readOnly(false)
                .transSplit(false)
                .connectionPool(true)
                .autoLoadBalance(true)
                .accessMode("nearby")
                .proxyAllocations(            
                    MysqlProxyAddressConfigProxyAllocationArgs.builder()
                        .region("ap-guangzhou")
                        .zone("ap-guangzhou-6")
                        .proxyInstances(MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs.builder()
                            .instanceId("cdb-o2t7gmjl")
                            .weight(0.0)
                            .build())
                        .build(),
                    MysqlProxyAddressConfigProxyAllocationArgs.builder()
                        .region("ap-guangzhou")
                        .zone("ap-guangzhou-7")
                        .proxyInstances(MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs.builder()
                            .instanceId("cdb-o2t7gmjl")
                            .weight(0.0)
                            .build())
                        .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: tencentcloud:MysqlProxyAddressConfig
        properties:
          instanceId: cdb-o2t7gmjl
          proxyGroupId: proxy-ov7dqp8n
          proxyAddressId: proxyaddr-y8dnlfs0
          weightMode: system
          isKickOut: true
          minCount: 0
          maxDelay: 10
          failOver: true
          autoAddRo: true
          readOnly: false
          transSplit: false
          connectionPool: true
          autoLoadBalance: true
          accessMode: nearby
          proxyAllocations:
            - region: ap-guangzhou
              zone: ap-guangzhou-6
              proxyInstances:
                - instanceId: cdb-o2t7gmjl
                  weight: 0
            - region: ap-guangzhou
              zone: ap-guangzhou-7
              proxyInstances:
                - instanceId: cdb-o2t7gmjl
                  weight: 0
    
    Example coming soon!
    

    Create MysqlProxyAddressConfig Resource

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

    Constructor syntax

    new MysqlProxyAddressConfig(name: string, args: MysqlProxyAddressConfigArgs, opts?: CustomResourceOptions);
    @overload
    def MysqlProxyAddressConfig(resource_name: str,
                                args: MysqlProxyAddressConfigArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def MysqlProxyAddressConfig(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                proxy_address_id: Optional[str] = None,
                                max_delay: Optional[float] = None,
                                weight_mode: Optional[str] = None,
                                auto_add_ro: Optional[bool] = None,
                                read_only: Optional[bool] = None,
                                is_kick_out: Optional[bool] = None,
                                fail_over: Optional[bool] = None,
                                instance_id: Optional[str] = None,
                                proxy_group_id: Optional[str] = None,
                                min_count: Optional[float] = None,
                                connection_pool: Optional[bool] = None,
                                mysql_proxy_address_config_id: Optional[str] = None,
                                access_mode: Optional[str] = None,
                                proxy_allocations: Optional[Sequence[MysqlProxyAddressConfigProxyAllocationArgs]] = None,
                                ap_node_as_ro_node: Optional[bool] = None,
                                auto_load_balance: Optional[bool] = None,
                                trans_split: Optional[bool] = None,
                                ap_query_to_other_node: Optional[bool] = None)
    func NewMysqlProxyAddressConfig(ctx *Context, name string, args MysqlProxyAddressConfigArgs, opts ...ResourceOption) (*MysqlProxyAddressConfig, error)
    public MysqlProxyAddressConfig(string name, MysqlProxyAddressConfigArgs args, CustomResourceOptions? opts = null)
    public MysqlProxyAddressConfig(String name, MysqlProxyAddressConfigArgs args)
    public MysqlProxyAddressConfig(String name, MysqlProxyAddressConfigArgs args, CustomResourceOptions options)
    
    type: tencentcloud:MysqlProxyAddressConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "tencentcloud_mysqlproxyaddressconfig" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MysqlProxyAddressConfigArgs
    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 MysqlProxyAddressConfigArgs
    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 MysqlProxyAddressConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MysqlProxyAddressConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MysqlProxyAddressConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AutoAddRo bool
    Whether to automatically add read-only instances. Valid values: true, false.
    FailOver bool
    Whether to enable failover. Valid values: true, false.
    InstanceId string
    Instance ID, such as: cdb-xxxxxxxx.
    IsKickOut bool
    Whether to enable delay elimination. Valid values: true, false.
    MaxDelay double
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    MinCount double
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    ProxyAddressId string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ProxyGroupId string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ReadOnly bool
    Whether it is read-only. Valid values: true, false.
    WeightMode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    AccessMode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ApNodeAsRoNode bool
    Whether to treat libra nodes as regular RO nodes.
    ApQueryToOtherNode bool
    When libra node fails, whether to forward to other nodes.
    AutoLoadBalance bool
    Whether to enable adaptive load balancing. Default is disabled.
    ConnectionPool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    MysqlProxyAddressConfigId string
    ID of the resource.
    ProxyAllocations List<MysqlProxyAddressConfigProxyAllocation>
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    TransSplit bool
    Whether to enable transaction splitting. Default value: false.
    AutoAddRo bool
    Whether to automatically add read-only instances. Valid values: true, false.
    FailOver bool
    Whether to enable failover. Valid values: true, false.
    InstanceId string
    Instance ID, such as: cdb-xxxxxxxx.
    IsKickOut bool
    Whether to enable delay elimination. Valid values: true, false.
    MaxDelay float64
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    MinCount float64
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    ProxyAddressId string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ProxyGroupId string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ReadOnly bool
    Whether it is read-only. Valid values: true, false.
    WeightMode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    AccessMode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ApNodeAsRoNode bool
    Whether to treat libra nodes as regular RO nodes.
    ApQueryToOtherNode bool
    When libra node fails, whether to forward to other nodes.
    AutoLoadBalance bool
    Whether to enable adaptive load balancing. Default is disabled.
    ConnectionPool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    MysqlProxyAddressConfigId string
    ID of the resource.
    ProxyAllocations []MysqlProxyAddressConfigProxyAllocationArgs
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    TransSplit bool
    Whether to enable transaction splitting. Default value: false.
    auto_add_ro bool
    Whether to automatically add read-only instances. Valid values: true, false.
    fail_over bool
    Whether to enable failover. Valid values: true, false.
    instance_id string
    Instance ID, such as: cdb-xxxxxxxx.
    is_kick_out bool
    Whether to enable delay elimination. Valid values: true, false.
    max_delay number
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    min_count number
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    proxy_address_id string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxy_group_id string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    read_only bool
    Whether it is read-only. Valid values: true, false.
    weight_mode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    access_mode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ap_node_as_ro_node bool
    Whether to treat libra nodes as regular RO nodes.
    ap_query_to_other_node bool
    When libra node fails, whether to forward to other nodes.
    auto_load_balance bool
    Whether to enable adaptive load balancing. Default is disabled.
    connection_pool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    mysql_proxy_address_config_id string
    ID of the resource.
    proxy_allocations list(object)
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    trans_split bool
    Whether to enable transaction splitting. Default value: false.
    autoAddRo Boolean
    Whether to automatically add read-only instances. Valid values: true, false.
    failOver Boolean
    Whether to enable failover. Valid values: true, false.
    instanceId String
    Instance ID, such as: cdb-xxxxxxxx.
    isKickOut Boolean
    Whether to enable delay elimination. Valid values: true, false.
    maxDelay Double
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    minCount Double
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    proxyAddressId String
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxyGroupId String
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    readOnly Boolean
    Whether it is read-only. Valid values: true, false.
    weightMode String
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    accessMode String
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    apNodeAsRoNode Boolean
    Whether to treat libra nodes as regular RO nodes.
    apQueryToOtherNode Boolean
    When libra node fails, whether to forward to other nodes.
    autoLoadBalance Boolean
    Whether to enable adaptive load balancing. Default is disabled.
    connectionPool Boolean
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    mysqlProxyAddressConfigId String
    ID of the resource.
    proxyAllocations List<MysqlProxyAddressConfigProxyAllocation>
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    transSplit Boolean
    Whether to enable transaction splitting. Default value: false.
    autoAddRo boolean
    Whether to automatically add read-only instances. Valid values: true, false.
    failOver boolean
    Whether to enable failover. Valid values: true, false.
    instanceId string
    Instance ID, such as: cdb-xxxxxxxx.
    isKickOut boolean
    Whether to enable delay elimination. Valid values: true, false.
    maxDelay number
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    minCount number
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    proxyAddressId string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxyGroupId string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    readOnly boolean
    Whether it is read-only. Valid values: true, false.
    weightMode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    accessMode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    apNodeAsRoNode boolean
    Whether to treat libra nodes as regular RO nodes.
    apQueryToOtherNode boolean
    When libra node fails, whether to forward to other nodes.
    autoLoadBalance boolean
    Whether to enable adaptive load balancing. Default is disabled.
    connectionPool boolean
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    mysqlProxyAddressConfigId string
    ID of the resource.
    proxyAllocations MysqlProxyAddressConfigProxyAllocation[]
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    transSplit boolean
    Whether to enable transaction splitting. Default value: false.
    auto_add_ro bool
    Whether to automatically add read-only instances. Valid values: true, false.
    fail_over bool
    Whether to enable failover. Valid values: true, false.
    instance_id str
    Instance ID, such as: cdb-xxxxxxxx.
    is_kick_out bool
    Whether to enable delay elimination. Valid values: true, false.
    max_delay float
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    min_count float
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    proxy_address_id str
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxy_group_id str
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    read_only bool
    Whether it is read-only. Valid values: true, false.
    weight_mode str
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    access_mode str
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ap_node_as_ro_node bool
    Whether to treat libra nodes as regular RO nodes.
    ap_query_to_other_node bool
    When libra node fails, whether to forward to other nodes.
    auto_load_balance bool
    Whether to enable adaptive load balancing. Default is disabled.
    connection_pool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    mysql_proxy_address_config_id str
    ID of the resource.
    proxy_allocations Sequence[MysqlProxyAddressConfigProxyAllocationArgs]
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    trans_split bool
    Whether to enable transaction splitting. Default value: false.
    autoAddRo Boolean
    Whether to automatically add read-only instances. Valid values: true, false.
    failOver Boolean
    Whether to enable failover. Valid values: true, false.
    instanceId String
    Instance ID, such as: cdb-xxxxxxxx.
    isKickOut Boolean
    Whether to enable delay elimination. Valid values: true, false.
    maxDelay Number
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    minCount Number
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    proxyAddressId String
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxyGroupId String
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    readOnly Boolean
    Whether it is read-only. Valid values: true, false.
    weightMode String
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    accessMode String
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    apNodeAsRoNode Boolean
    Whether to treat libra nodes as regular RO nodes.
    apQueryToOtherNode Boolean
    When libra node fails, whether to forward to other nodes.
    autoLoadBalance Boolean
    Whether to enable adaptive load balancing. Default is disabled.
    connectionPool Boolean
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    mysqlProxyAddressConfigId String
    ID of the resource.
    proxyAllocations List<Property Map>
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    transSplit Boolean
    Whether to enable transaction splitting. Default value: false.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MysqlProxyAddressConfig Resource

    Get an existing MysqlProxyAddressConfig 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?: MysqlProxyAddressConfigState, opts?: CustomResourceOptions): MysqlProxyAddressConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_mode: Optional[str] = None,
            ap_node_as_ro_node: Optional[bool] = None,
            ap_query_to_other_node: Optional[bool] = None,
            auto_add_ro: Optional[bool] = None,
            auto_load_balance: Optional[bool] = None,
            connection_pool: Optional[bool] = None,
            fail_over: Optional[bool] = None,
            instance_id: Optional[str] = None,
            is_kick_out: Optional[bool] = None,
            max_delay: Optional[float] = None,
            min_count: Optional[float] = None,
            mysql_proxy_address_config_id: Optional[str] = None,
            proxy_address_id: Optional[str] = None,
            proxy_allocations: Optional[Sequence[MysqlProxyAddressConfigProxyAllocationArgs]] = None,
            proxy_group_id: Optional[str] = None,
            read_only: Optional[bool] = None,
            trans_split: Optional[bool] = None,
            weight_mode: Optional[str] = None) -> MysqlProxyAddressConfig
    func GetMysqlProxyAddressConfig(ctx *Context, name string, id IDInput, state *MysqlProxyAddressConfigState, opts ...ResourceOption) (*MysqlProxyAddressConfig, error)
    public static MysqlProxyAddressConfig Get(string name, Input<string> id, MysqlProxyAddressConfigState? state, CustomResourceOptions? opts = null)
    public static MysqlProxyAddressConfig get(String name, Output<String> id, MysqlProxyAddressConfigState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:MysqlProxyAddressConfig    get:      id: ${id}
    import {
      to = tencentcloud_mysqlproxyaddressconfig.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.
    The following state arguments are supported:
    AccessMode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ApNodeAsRoNode bool
    Whether to treat libra nodes as regular RO nodes.
    ApQueryToOtherNode bool
    When libra node fails, whether to forward to other nodes.
    AutoAddRo bool
    Whether to automatically add read-only instances. Valid values: true, false.
    AutoLoadBalance bool
    Whether to enable adaptive load balancing. Default is disabled.
    ConnectionPool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    FailOver bool
    Whether to enable failover. Valid values: true, false.
    InstanceId string
    Instance ID, such as: cdb-xxxxxxxx.
    IsKickOut bool
    Whether to enable delay elimination. Valid values: true, false.
    MaxDelay double
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    MinCount double
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    MysqlProxyAddressConfigId string
    ID of the resource.
    ProxyAddressId string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ProxyAllocations List<MysqlProxyAddressConfigProxyAllocation>
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    ProxyGroupId string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ReadOnly bool
    Whether it is read-only. Valid values: true, false.
    TransSplit bool
    Whether to enable transaction splitting. Default value: false.
    WeightMode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    AccessMode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ApNodeAsRoNode bool
    Whether to treat libra nodes as regular RO nodes.
    ApQueryToOtherNode bool
    When libra node fails, whether to forward to other nodes.
    AutoAddRo bool
    Whether to automatically add read-only instances. Valid values: true, false.
    AutoLoadBalance bool
    Whether to enable adaptive load balancing. Default is disabled.
    ConnectionPool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    FailOver bool
    Whether to enable failover. Valid values: true, false.
    InstanceId string
    Instance ID, such as: cdb-xxxxxxxx.
    IsKickOut bool
    Whether to enable delay elimination. Valid values: true, false.
    MaxDelay float64
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    MinCount float64
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    MysqlProxyAddressConfigId string
    ID of the resource.
    ProxyAddressId string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ProxyAllocations []MysqlProxyAddressConfigProxyAllocationArgs
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    ProxyGroupId string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    ReadOnly bool
    Whether it is read-only. Valid values: true, false.
    TransSplit bool
    Whether to enable transaction splitting. Default value: false.
    WeightMode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    access_mode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ap_node_as_ro_node bool
    Whether to treat libra nodes as regular RO nodes.
    ap_query_to_other_node bool
    When libra node fails, whether to forward to other nodes.
    auto_add_ro bool
    Whether to automatically add read-only instances. Valid values: true, false.
    auto_load_balance bool
    Whether to enable adaptive load balancing. Default is disabled.
    connection_pool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    fail_over bool
    Whether to enable failover. Valid values: true, false.
    instance_id string
    Instance ID, such as: cdb-xxxxxxxx.
    is_kick_out bool
    Whether to enable delay elimination. Valid values: true, false.
    max_delay number
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    min_count number
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    mysql_proxy_address_config_id string
    ID of the resource.
    proxy_address_id string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxy_allocations list(object)
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    proxy_group_id string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    read_only bool
    Whether it is read-only. Valid values: true, false.
    trans_split bool
    Whether to enable transaction splitting. Default value: false.
    weight_mode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    accessMode String
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    apNodeAsRoNode Boolean
    Whether to treat libra nodes as regular RO nodes.
    apQueryToOtherNode Boolean
    When libra node fails, whether to forward to other nodes.
    autoAddRo Boolean
    Whether to automatically add read-only instances. Valid values: true, false.
    autoLoadBalance Boolean
    Whether to enable adaptive load balancing. Default is disabled.
    connectionPool Boolean
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    failOver Boolean
    Whether to enable failover. Valid values: true, false.
    instanceId String
    Instance ID, such as: cdb-xxxxxxxx.
    isKickOut Boolean
    Whether to enable delay elimination. Valid values: true, false.
    maxDelay Double
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    minCount Double
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    mysqlProxyAddressConfigId String
    ID of the resource.
    proxyAddressId String
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxyAllocations List<MysqlProxyAddressConfigProxyAllocation>
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    proxyGroupId String
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    readOnly Boolean
    Whether it is read-only. Valid values: true, false.
    transSplit Boolean
    Whether to enable transaction splitting. Default value: false.
    weightMode String
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    accessMode string
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    apNodeAsRoNode boolean
    Whether to treat libra nodes as regular RO nodes.
    apQueryToOtherNode boolean
    When libra node fails, whether to forward to other nodes.
    autoAddRo boolean
    Whether to automatically add read-only instances. Valid values: true, false.
    autoLoadBalance boolean
    Whether to enable adaptive load balancing. Default is disabled.
    connectionPool boolean
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    failOver boolean
    Whether to enable failover. Valid values: true, false.
    instanceId string
    Instance ID, such as: cdb-xxxxxxxx.
    isKickOut boolean
    Whether to enable delay elimination. Valid values: true, false.
    maxDelay number
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    minCount number
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    mysqlProxyAddressConfigId string
    ID of the resource.
    proxyAddressId string
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxyAllocations MysqlProxyAddressConfigProxyAllocation[]
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    proxyGroupId string
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    readOnly boolean
    Whether it is read-only. Valid values: true, false.
    transSplit boolean
    Whether to enable transaction splitting. Default value: false.
    weightMode string
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    access_mode str
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    ap_node_as_ro_node bool
    Whether to treat libra nodes as regular RO nodes.
    ap_query_to_other_node bool
    When libra node fails, whether to forward to other nodes.
    auto_add_ro bool
    Whether to automatically add read-only instances. Valid values: true, false.
    auto_load_balance bool
    Whether to enable adaptive load balancing. Default is disabled.
    connection_pool bool
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    fail_over bool
    Whether to enable failover. Valid values: true, false.
    instance_id str
    Instance ID, such as: cdb-xxxxxxxx.
    is_kick_out bool
    Whether to enable delay elimination. Valid values: true, false.
    max_delay float
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    min_count float
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    mysql_proxy_address_config_id str
    ID of the resource.
    proxy_address_id str
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxy_allocations Sequence[MysqlProxyAddressConfigProxyAllocationArgs]
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    proxy_group_id str
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    read_only bool
    Whether it is read-only. Valid values: true, false.
    trans_split bool
    Whether to enable transaction splitting. Default value: false.
    weight_mode str
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).
    accessMode String
    Access mode. Valid values: nearby (nearby access), balance (load balancing). Default: nearby.
    apNodeAsRoNode Boolean
    Whether to treat libra nodes as regular RO nodes.
    apQueryToOtherNode Boolean
    When libra node fails, whether to forward to other nodes.
    autoAddRo Boolean
    Whether to automatically add read-only instances. Valid values: true, false.
    autoLoadBalance Boolean
    Whether to enable adaptive load balancing. Default is disabled.
    connectionPool Boolean
    Whether to enable connection pool. Default is disabled. Note: for MySQL 8.0, the kernel minor version must be >= MySQL 8.0 20230630.
    failOver Boolean
    Whether to enable failover. Valid values: true, false.
    instanceId String
    Instance ID, such as: cdb-xxxxxxxx.
    isKickOut Boolean
    Whether to enable delay elimination. Valid values: true, false.
    maxDelay Number
    Delay elimination threshold in milliseconds. Value range: [1, 10000].
    minCount Number
    Minimum reserved quantity. Minimum value: 0. Note: only valid when IsKickOut is true.
    mysqlProxyAddressConfigId String
    ID of the resource.
    proxyAddressId String
    Proxy address ID, such as: proxyaddr-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    proxyAllocations List<Property Map>
    Read/write weight allocation. If WeightMode is system, the input weight does not take effect.
    proxyGroupId String
    Proxy group ID, such as: proxy-xxxxxxxx. Can be obtained through the DescribeCdbProxyInfo interface.
    readOnly Boolean
    Whether it is read-only. Valid values: true, false.
    transSplit Boolean
    Whether to enable transaction splitting. Default value: false.
    weightMode String
    Weight allocation mode. Valid values: system (system auto-allocation), custom (custom).

    Supporting Types

    MysqlProxyAddressConfigProxyAllocation, MysqlProxyAddressConfigProxyAllocationArgs

    ProxyInstances List<MysqlProxyAddressConfigProxyAllocationProxyInstance>
    Proxy instance list.
    Region string
    Region, such as: ap-guangzhou.
    Zone string
    Availability zone, such as: ap-guangzhou-2.
    ProxyInstances []MysqlProxyAddressConfigProxyAllocationProxyInstance
    Proxy instance list.
    Region string
    Region, such as: ap-guangzhou.
    Zone string
    Availability zone, such as: ap-guangzhou-2.
    proxy_instances list(object)
    Proxy instance list.
    region string
    Region, such as: ap-guangzhou.
    zone string
    Availability zone, such as: ap-guangzhou-2.
    proxyInstances List<MysqlProxyAddressConfigProxyAllocationProxyInstance>
    Proxy instance list.
    region String
    Region, such as: ap-guangzhou.
    zone String
    Availability zone, such as: ap-guangzhou-2.
    proxyInstances MysqlProxyAddressConfigProxyAllocationProxyInstance[]
    Proxy instance list.
    region string
    Region, such as: ap-guangzhou.
    zone string
    Availability zone, such as: ap-guangzhou-2.
    proxy_instances Sequence[MysqlProxyAddressConfigProxyAllocationProxyInstance]
    Proxy instance list.
    region str
    Region, such as: ap-guangzhou.
    zone str
    Availability zone, such as: ap-guangzhou-2.
    proxyInstances List<Property Map>
    Proxy instance list.
    region String
    Region, such as: ap-guangzhou.
    zone String
    Availability zone, such as: ap-guangzhou-2.

    MysqlProxyAddressConfigProxyAllocationProxyInstance, MysqlProxyAddressConfigProxyAllocationProxyInstanceArgs

    InstanceId string
    Instance ID.
    Weight double
    Weight value.
    InstanceId string
    Instance ID.
    Weight float64
    Weight value.
    instance_id string
    Instance ID.
    weight number
    Weight value.
    instanceId String
    Instance ID.
    weight Double
    Weight value.
    instanceId string
    Instance ID.
    weight number
    Weight value.
    instance_id str
    Instance ID.
    weight float
    Weight value.
    instanceId String
    Instance ID.
    weight Number
    Weight value.

    Import

    MySQL proxy address config can be imported using the instanceId#proxyGroupId#proxyAddressId, e.g.

    $ pulumi import tencentcloud:index/mysqlProxyAddressConfig:MysqlProxyAddressConfig example cdb-o2t7gmjl#proxy-ov7dqp8n#proxyaddr-y8dnlfs0
    

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    Viewing docs for tencentcloud 1.82.93
    published on Monday, May 11, 2026 by tencentcloudstack
      Try Pulumi Cloud free. Your team will thank you.