1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmysql
  6. Instance
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine

    Volcano Engine Cloud Database MySQL Edition is an elastic and reliable online relational database service built on the open-source MySQL database. MySQL instances are deployed using cloud-native methods and local SSD storage, delivering high-performance read and write capabilities. The service is fully compatible with the MySQL engine and offers a complete suite of solutions, including instance management, backup and recovery, log management, monitoring and alerts, and data migration. This helps enterprises simplify complex database management and operations, allowing them to focus more time and resources on their core business.

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      rDSMySQLInstanceDemo:
        type: volcenginecc:rdsmysql:Instance
        name: RDSMySQLInstanceDemo
        properties:
          deletionProtection: Disabled
          dbEngineVersion: MySQL_5_7
          nodes:
            - zone_id: cn-beijing-a
              node_spec: rds.mysql.c.s.1c2g
              node_type: Primary
            - zone_id: cn-beijing-a
              node_spec: rds.mysql.c.s.1c2g
              node_type: Secondary
            - zone_id: cn-beijing-a
              node_spec: rds.mysql.c.s.1c2g
              node_type: ReadOnly
          storageType: CloudESSD_PL0
          storageSpace: 100
          instanceType: DoubleNode
          vpcId: vpc-rrco37ovjq4gv0x58xxxxx
          subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx
          instanceName: RDSMySQLInstanceDemo
          superAccountName: test_account
          superAccountPassword: '***********'
          lowerCaseTableNames: '1'
          dbTimeZone: UTC +08:00
          chargeDetail:
            charge_type: PostPaid
            auto_renew: false
            number: 1
          allowListIds:
            - acl-8cde5e16f44143788234ca4489xxxxx
            - acl-31f6053bd6be4cff88c1b205d20xxxxx
          port: 3306
          maintenanceWindow:
            day_kind: Week
            day_of_week:
              - Monday
            maintenance_time: 18:00Z-21:59Z
          autoStorageScalingConfig:
            enable_storage_auto_scale: true
            storage_threshold: 10
            storage_upper_bound: 3000
          projectName: default
          tags:
            - key: env
              value: test
    

    Create Instance Resource

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

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 nodes: Optional[Sequence[InstanceNodeArgs]] = None,
                 vpc_id: Optional[str] = None,
                 subnet_id: Optional[str] = None,
                 charge_detail: Optional[InstanceChargeDetailArgs] = None,
                 storage_type: Optional[str] = None,
                 db_engine_version: Optional[str] = None,
                 storage_space: Optional[int] = None,
                 db_param_group_id: Optional[str] = None,
                 port: Optional[int] = None,
                 global_read_only: Optional[bool] = None,
                 instance_name: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 lower_case_table_names: Optional[str] = None,
                 maintenance_window: Optional[InstanceMaintenanceWindowArgs] = None,
                 node_spec: Optional[str] = None,
                 db_time_zone: Optional[str] = None,
                 deletion_protection: Optional[str] = None,
                 project_name: Optional[str] = None,
                 allow_list_ids: Optional[Sequence[str]] = None,
                 cpu_num: Optional[int] = None,
                 auto_upgrade_minor_version: Optional[str] = None,
                 super_account_name: Optional[str] = None,
                 super_account_password: Optional[str] = None,
                 sync_mode: Optional[str] = None,
                 tags: Optional[Sequence[InstanceTagArgs]] = None,
                 auto_storage_scaling_config: Optional[InstanceAutoStorageScalingConfigArgs] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:rdsmysql:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromRdsmysqlinstance = new Volcenginecc.Rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", new()
    {
        Nodes = new[]
        {
            new Volcenginecc.Rdsmysql.Inputs.InstanceNodeArgs
            {
                NodeSpec = "string",
                NodeType = "string",
                ZoneId = "string",
            },
        },
        VpcId = "string",
        SubnetId = "string",
        ChargeDetail = new Volcenginecc.Rdsmysql.Inputs.InstanceChargeDetailArgs
        {
            ChargeType = "string",
            AutoRenew = false,
            ChargeEndTime = "string",
            ChargeStartTime = "string",
            ChargeStatus = "string",
            Number = 0,
            OverdueReclaimTime = "string",
            OverdueTime = "string",
            Period = 0,
            PeriodUnit = "string",
            TempModifyEndTime = "string",
            TempModifyStartTime = "string",
        },
        StorageType = "string",
        DbEngineVersion = "string",
        StorageSpace = 0,
        DbParamGroupId = "string",
        Port = 0,
        GlobalReadOnly = false,
        InstanceName = "string",
        InstanceType = "string",
        LowerCaseTableNames = "string",
        MaintenanceWindow = new Volcenginecc.Rdsmysql.Inputs.InstanceMaintenanceWindowArgs
        {
            DayKind = "string",
            DayOfWeeks = new[]
            {
                "string",
            },
            MaintenanceTime = "string",
        },
        NodeSpec = "string",
        DbTimeZone = "string",
        DeletionProtection = "string",
        ProjectName = "string",
        AllowListIds = new[]
        {
            "string",
        },
        CpuNum = 0,
        AutoUpgradeMinorVersion = "string",
        SuperAccountName = "string",
        SuperAccountPassword = "string",
        SyncMode = "string",
        Tags = new[]
        {
            new Volcenginecc.Rdsmysql.Inputs.InstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        AutoStorageScalingConfig = new Volcenginecc.Rdsmysql.Inputs.InstanceAutoStorageScalingConfigArgs
        {
            EnableStorageAutoScale = false,
            StorageThreshold = 0,
            StorageUpperBound = 0,
        },
    });
    
    example, err := rdsmysql.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsmysqlinstance", &rdsmysql.InstanceArgs{
    	Nodes: rdsmysql.InstanceNodeArray{
    		&rdsmysql.InstanceNodeArgs{
    			NodeSpec: pulumi.String("string"),
    			NodeType: pulumi.String("string"),
    			ZoneId:   pulumi.String("string"),
    		},
    	},
    	VpcId:    pulumi.String("string"),
    	SubnetId: pulumi.String("string"),
    	ChargeDetail: &rdsmysql.InstanceChargeDetailArgs{
    		ChargeType:          pulumi.String("string"),
    		AutoRenew:           pulumi.Bool(false),
    		ChargeEndTime:       pulumi.String("string"),
    		ChargeStartTime:     pulumi.String("string"),
    		ChargeStatus:        pulumi.String("string"),
    		Number:              pulumi.Int(0),
    		OverdueReclaimTime:  pulumi.String("string"),
    		OverdueTime:         pulumi.String("string"),
    		Period:              pulumi.Int(0),
    		PeriodUnit:          pulumi.String("string"),
    		TempModifyEndTime:   pulumi.String("string"),
    		TempModifyStartTime: pulumi.String("string"),
    	},
    	StorageType:         pulumi.String("string"),
    	DbEngineVersion:     pulumi.String("string"),
    	StorageSpace:        pulumi.Int(0),
    	DbParamGroupId:      pulumi.String("string"),
    	Port:                pulumi.Int(0),
    	GlobalReadOnly:      pulumi.Bool(false),
    	InstanceName:        pulumi.String("string"),
    	InstanceType:        pulumi.String("string"),
    	LowerCaseTableNames: pulumi.String("string"),
    	MaintenanceWindow: &rdsmysql.InstanceMaintenanceWindowArgs{
    		DayKind: pulumi.String("string"),
    		DayOfWeeks: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		MaintenanceTime: pulumi.String("string"),
    	},
    	NodeSpec:           pulumi.String("string"),
    	DbTimeZone:         pulumi.String("string"),
    	DeletionProtection: pulumi.String("string"),
    	ProjectName:        pulumi.String("string"),
    	AllowListIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	CpuNum:                  pulumi.Int(0),
    	AutoUpgradeMinorVersion: pulumi.String("string"),
    	SuperAccountName:        pulumi.String("string"),
    	SuperAccountPassword:    pulumi.String("string"),
    	SyncMode:                pulumi.String("string"),
    	Tags: rdsmysql.InstanceTagArray{
    		&rdsmysql.InstanceTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	AutoStorageScalingConfig: &rdsmysql.InstanceAutoStorageScalingConfigArgs{
    		EnableStorageAutoScale: pulumi.Bool(false),
    		StorageThreshold:       pulumi.Int(0),
    		StorageUpperBound:      pulumi.Int(0),
    	},
    })
    
    var exampleinstanceResourceResourceFromRdsmysqlinstance = new com.volcengine.volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", com.volcengine.volcenginecc.rdsmysql.InstanceArgs.builder()
        .nodes(InstanceNodeArgs.builder()
            .nodeSpec("string")
            .nodeType("string")
            .zoneId("string")
            .build())
        .vpcId("string")
        .subnetId("string")
        .chargeDetail(InstanceChargeDetailArgs.builder()
            .chargeType("string")
            .autoRenew(false)
            .chargeEndTime("string")
            .chargeStartTime("string")
            .chargeStatus("string")
            .number(0)
            .overdueReclaimTime("string")
            .overdueTime("string")
            .period(0)
            .periodUnit("string")
            .tempModifyEndTime("string")
            .tempModifyStartTime("string")
            .build())
        .storageType("string")
        .dbEngineVersion("string")
        .storageSpace(0)
        .dbParamGroupId("string")
        .port(0)
        .globalReadOnly(false)
        .instanceName("string")
        .instanceType("string")
        .lowerCaseTableNames("string")
        .maintenanceWindow(InstanceMaintenanceWindowArgs.builder()
            .dayKind("string")
            .dayOfWeeks("string")
            .maintenanceTime("string")
            .build())
        .nodeSpec("string")
        .dbTimeZone("string")
        .deletionProtection("string")
        .projectName("string")
        .allowListIds("string")
        .cpuNum(0)
        .autoUpgradeMinorVersion("string")
        .superAccountName("string")
        .superAccountPassword("string")
        .syncMode("string")
        .tags(InstanceTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .autoStorageScalingConfig(InstanceAutoStorageScalingConfigArgs.builder()
            .enableStorageAutoScale(false)
            .storageThreshold(0)
            .storageUpperBound(0)
            .build())
        .build());
    
    exampleinstance_resource_resource_from_rdsmysqlinstance = volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance",
        nodes=[{
            "node_spec": "string",
            "node_type": "string",
            "zone_id": "string",
        }],
        vpc_id="string",
        subnet_id="string",
        charge_detail={
            "charge_type": "string",
            "auto_renew": False,
            "charge_end_time": "string",
            "charge_start_time": "string",
            "charge_status": "string",
            "number": 0,
            "overdue_reclaim_time": "string",
            "overdue_time": "string",
            "period": 0,
            "period_unit": "string",
            "temp_modify_end_time": "string",
            "temp_modify_start_time": "string",
        },
        storage_type="string",
        db_engine_version="string",
        storage_space=0,
        db_param_group_id="string",
        port=0,
        global_read_only=False,
        instance_name="string",
        instance_type="string",
        lower_case_table_names="string",
        maintenance_window={
            "day_kind": "string",
            "day_of_weeks": ["string"],
            "maintenance_time": "string",
        },
        node_spec="string",
        db_time_zone="string",
        deletion_protection="string",
        project_name="string",
        allow_list_ids=["string"],
        cpu_num=0,
        auto_upgrade_minor_version="string",
        super_account_name="string",
        super_account_password="string",
        sync_mode="string",
        tags=[{
            "key": "string",
            "value": "string",
        }],
        auto_storage_scaling_config={
            "enable_storage_auto_scale": False,
            "storage_threshold": 0,
            "storage_upper_bound": 0,
        })
    
    const exampleinstanceResourceResourceFromRdsmysqlinstance = new volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", {
        nodes: [{
            nodeSpec: "string",
            nodeType: "string",
            zoneId: "string",
        }],
        vpcId: "string",
        subnetId: "string",
        chargeDetail: {
            chargeType: "string",
            autoRenew: false,
            chargeEndTime: "string",
            chargeStartTime: "string",
            chargeStatus: "string",
            number: 0,
            overdueReclaimTime: "string",
            overdueTime: "string",
            period: 0,
            periodUnit: "string",
            tempModifyEndTime: "string",
            tempModifyStartTime: "string",
        },
        storageType: "string",
        dbEngineVersion: "string",
        storageSpace: 0,
        dbParamGroupId: "string",
        port: 0,
        globalReadOnly: false,
        instanceName: "string",
        instanceType: "string",
        lowerCaseTableNames: "string",
        maintenanceWindow: {
            dayKind: "string",
            dayOfWeeks: ["string"],
            maintenanceTime: "string",
        },
        nodeSpec: "string",
        dbTimeZone: "string",
        deletionProtection: "string",
        projectName: "string",
        allowListIds: ["string"],
        cpuNum: 0,
        autoUpgradeMinorVersion: "string",
        superAccountName: "string",
        superAccountPassword: "string",
        syncMode: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        autoStorageScalingConfig: {
            enableStorageAutoScale: false,
            storageThreshold: 0,
            storageUpperBound: 0,
        },
    });
    
    type: volcenginecc:rdsmysql:Instance
    properties:
        allowListIds:
            - string
        autoStorageScalingConfig:
            enableStorageAutoScale: false
            storageThreshold: 0
            storageUpperBound: 0
        autoUpgradeMinorVersion: string
        chargeDetail:
            autoRenew: false
            chargeEndTime: string
            chargeStartTime: string
            chargeStatus: string
            chargeType: string
            number: 0
            overdueReclaimTime: string
            overdueTime: string
            period: 0
            periodUnit: string
            tempModifyEndTime: string
            tempModifyStartTime: string
        cpuNum: 0
        dbEngineVersion: string
        dbParamGroupId: string
        dbTimeZone: string
        deletionProtection: string
        globalReadOnly: false
        instanceName: string
        instanceType: string
        lowerCaseTableNames: string
        maintenanceWindow:
            dayKind: string
            dayOfWeeks:
                - string
            maintenanceTime: string
        nodeSpec: string
        nodes:
            - nodeSpec: string
              nodeType: string
              zoneId: string
        port: 0
        projectName: string
        storageSpace: 0
        storageType: string
        subnetId: string
        superAccountName: string
        superAccountPassword: string
        syncMode: string
        tags:
            - key: string
              value: string
        vpcId: string
    

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

    ChargeDetail Volcengine.InstanceChargeDetail
    Billing method
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    Nodes List<Volcengine.InstanceNode>
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    SubnetId string
    Subnet ID.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    AllowListIds List<string>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AutoStorageScalingConfig Volcengine.InstanceAutoStorageScalingConfig
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    InstanceName string
    Instance name.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow Volcengine.InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    NodeSpec string
    Node specifications.
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    ProjectName string
    Project.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags List<Volcengine.InstanceTag>
    ChargeDetail InstanceChargeDetailArgs
    Billing method
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    Nodes []InstanceNodeArgs
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    SubnetId string
    Subnet ID.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    AllowListIds []string
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AutoStorageScalingConfig InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    InstanceName string
    Instance name.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    NodeSpec string
    Node specifications.
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    ProjectName string
    Project.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags []InstanceTagArgs
    chargeDetail InstanceChargeDetail
    Billing method
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes List<InstanceNode>
    storageSpace Integer
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnetId String
    Subnet ID.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    cpuNum Integer
    Number of CPU cores for the database proxy service of the instance
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instanceName String
    Instance name.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    nodeSpec String
    Node specifications.
    port Integer
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    projectName String
    Project.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<InstanceTag>
    chargeDetail InstanceChargeDetail
    Billing method
    dbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes InstanceNode[]
    storageSpace number
    Total storage space of the instance, in GB
    storageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnetId string
    Subnet ID.
    vpcId string
    VPC (Virtual Private Cloud) ID.
    allowListIds string[]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    cpuNum number
    Number of CPU cores for the database proxy service of the instance
    dbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    globalReadOnly boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instanceName string
    Instance name.
    instanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    nodeSpec string
    Node specifications.
    port number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    projectName string
    Project.
    superAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags InstanceTag[]
    charge_detail InstanceChargeDetailArgs
    Billing method
    db_engine_version str
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes Sequence[InstanceNodeArgs]
    storage_space int
    Total storage space of the instance, in GB
    storage_type str
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnet_id str
    Subnet ID.
    vpc_id str
    VPC (Virtual Private Cloud) ID.
    allow_list_ids Sequence[str]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    auto_storage_scaling_config InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    auto_upgrade_minor_version str
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    cpu_num int
    Number of CPU cores for the database proxy service of the instance
    db_param_group_id str
    Parameter template ID. Default value is the default parameter template for the database engine version
    db_time_zone str
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletion_protection str
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    global_read_only bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instance_name str
    Instance name.
    instance_type str
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lower_case_table_names str
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenance_window InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    node_spec str
    Node specifications.
    port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    project_name str
    Project.
    super_account_name str
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    super_account_password str
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    sync_mode str
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags Sequence[InstanceTagArgs]
    chargeDetail Property Map
    Billing method
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    nodes List<Property Map>
    storageSpace Number
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    subnetId String
    Subnet ID.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    autoStorageScalingConfig Property Map
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    cpuNum Number
    Number of CPU cores for the database proxy service of the instance
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    instanceName String
    Instance name.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow Property Map
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    nodeSpec String
    Node specifications.
    port Number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    projectName String
    Project.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<Property Map>

    Outputs

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

    AddressObjects List<Volcengine.InstanceAddressObject>
    AllowListVersion string
    Allowlist version
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse double
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DisasterRecoveryInstances List<Volcengine.InstanceDisasterRecoveryInstance>
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints List<Volcengine.InstanceEndpoint>
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status.
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage double
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage double
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage double
    Average disk usage of the primary node over the past minute
    ProxyDetail Volcengine.InstanceProxyDetail
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageUse double
    Storage space used by the instance, in GB
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds List<string>
    List of availability zones for each node in the instance.
    AddressObjects []InstanceAddressObject
    AllowListVersion string
    Allowlist version
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse float64
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DisasterRecoveryInstances []InstanceDisasterRecoveryInstance
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints []InstanceEndpoint
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status.
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage float64
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage float64
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage float64
    Average disk usage of the primary node over the past minute
    ProxyDetail InstanceProxyDetail
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageUse float64
    Storage space used by the instance, in GB
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds []string
    List of availability zones for each node in the instance.
    addressObjects List<InstanceAddressObject>
    allowListVersion String
    Allowlist version
    backupAuditLogSize Integer
    Space used by audit logs in backup.
    backupBinLogSize Integer
    Space used by binlog logs in backup.
    backupDataSize Integer
    Space used by data in backup.
    backupErrorLogSize Integer
    Space used by error logs in backups.
    backupFreeQuotaSize Integer
    Free backup storage space, in GB
    backupLogSize Integer
    Space used by logs in backups.
    backupSlowLogSize Integer
    Space used by slow logs in backups.
    backupUse Double
    Backup space used by the instance, in GB
    basicBackupBinlogSize Integer
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Integer
    Space used by data in the base backup
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    disasterRecoveryInstances List<InstanceDisasterRecoveryInstance>
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Integer
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<InstanceEndpoint>
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status.
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Integer
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Double
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Double
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Double
    Average disk usage of the primary node over the past minute
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize Integer
    Space used by audit logs in instance storage
    storageBinLogSize Integer
    Binlog space usage in the instance storage
    storageDataSize Integer
    Space used by data in instance storage.
    storageErrorLogSize Integer
    Space used by error logs in instance storage.
    storageLogSize Integer
    Space used by logs in the instance storage
    storageSlowLogSize Integer
    Space used by slow logs in instance storage
    storageUse Double
    Storage space used by the instance, in GB
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Integer
    CPU size. For example: 1 means 1U.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.
    addressObjects InstanceAddressObject[]
    allowListVersion string
    Allowlist version
    backupAuditLogSize number
    Space used by audit logs in backup.
    backupBinLogSize number
    Space used by binlog logs in backup.
    backupDataSize number
    Space used by data in backup.
    backupErrorLogSize number
    Space used by error logs in backups.
    backupFreeQuotaSize number
    Free backup storage space, in GB
    backupLogSize number
    Space used by logs in backups.
    backupSlowLogSize number
    Space used by slow logs in backups.
    backupUse number
    Backup space used by the instance, in GB
    basicBackupBinlogSize number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize number
    Space used by data in the base backup
    createdTime string
    Instance creation local time.
    currentKernelVersion string
    Instance kernel minor version.
    disasterRecoveryInstances InstanceDisasterRecoveryInstance[]
    drDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster number
    Latency between the disaster recovery instance and the primary instance.
    endpoints InstanceEndpoint[]
    hasDisasterRecoveryInstances boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID.
    instanceStatus string
    Instance status.
    masterInstanceId string
    Primary instance ID
    masterInstanceName string
    Primary instance name.
    memory number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage number
    Average memory usage of the primary node over the past minute
    nodeNumber string
    Number of nodes.
    nodeSpaceUsedPercentage number
    Average disk usage of the primary node over the past minute
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize number
    Space used by audit logs in instance storage
    storageBinLogSize number
    Binlog space usage in the instance storage
    storageDataSize number
    Space used by data in instance storage.
    storageErrorLogSize number
    Space used by error logs in instance storage.
    storageLogSize number
    Space used by logs in the instance storage
    storageSlowLogSize number
    Space used by slow logs in instance storage
    storageUse number
    Storage space used by the instance, in GB
    timeZone string
    Time zone
    updatedTime string
    Instance updates local time.
    vcpu number
    CPU size. For example: 1 means 1U.
    zoneId string
    Availability zone of the instance's primary node.
    zoneIds string[]
    List of availability zones for each node in the instance.
    address_objects Sequence[InstanceAddressObject]
    allow_list_version str
    Allowlist version
    backup_audit_log_size int
    Space used by audit logs in backup.
    backup_bin_log_size int
    Space used by binlog logs in backup.
    backup_data_size int
    Space used by data in backup.
    backup_error_log_size int
    Space used by error logs in backups.
    backup_free_quota_size int
    Free backup storage space, in GB
    backup_log_size int
    Space used by logs in backups.
    backup_slow_log_size int
    Space used by slow logs in backups.
    backup_use float
    Backup space used by the instance, in GB
    basic_backup_binlog_size int
    Space used by Binlog logs in basic backups.
    basic_backup_data_size int
    Space used by data in the base backup
    created_time str
    Instance creation local time.
    current_kernel_version str
    Instance kernel minor version.
    disaster_recovery_instances Sequence[InstanceDisasterRecoveryInstance]
    dr_dts_task_id str
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    dr_dts_task_name str
    Name of synchronization tasks between primary and disaster recovery instances.
    dr_dts_task_status str
    Status of synchronization tasks between primary and disaster recovery instances.
    dr_seconds_behind_master int
    Latency between the disaster recovery instance and the primary instance.
    endpoints Sequence[InstanceEndpoint]
    has_disaster_recovery_instances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    has_green_instance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Instance ID.
    instance_status str
    Instance status.
    master_instance_id str
    Primary instance ID
    master_instance_name str
    Primary instance name.
    memory int
    Memory size. Unit: GB.
    node_cpu_used_percentage float
    Average CPU usage of the primary node in the instance over the past minute.
    node_memory_used_percentage float
    Average memory usage of the primary node over the past minute
    node_number str
    Number of nodes.
    node_space_used_percentage float
    Average disk usage of the primary node over the past minute
    proxy_detail InstanceProxyDetail
    proxy information
    storage_audit_log_size int
    Space used by audit logs in instance storage
    storage_bin_log_size int
    Binlog space usage in the instance storage
    storage_data_size int
    Space used by data in instance storage.
    storage_error_log_size int
    Space used by error logs in instance storage.
    storage_log_size int
    Space used by logs in the instance storage
    storage_slow_log_size int
    Space used by slow logs in instance storage
    storage_use float
    Storage space used by the instance, in GB
    time_zone str
    Time zone
    updated_time str
    Instance updates local time.
    vcpu int
    CPU size. For example: 1 means 1U.
    zone_id str
    Availability zone of the instance's primary node.
    zone_ids Sequence[str]
    List of availability zones for each node in the instance.
    addressObjects List<Property Map>
    allowListVersion String
    Allowlist version
    backupAuditLogSize Number
    Space used by audit logs in backup.
    backupBinLogSize Number
    Space used by binlog logs in backup.
    backupDataSize Number
    Space used by data in backup.
    backupErrorLogSize Number
    Space used by error logs in backups.
    backupFreeQuotaSize Number
    Free backup storage space, in GB
    backupLogSize Number
    Space used by logs in backups.
    backupSlowLogSize Number
    Space used by slow logs in backups.
    backupUse Number
    Backup space used by the instance, in GB
    basicBackupBinlogSize Number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Number
    Space used by data in the base backup
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    disasterRecoveryInstances List<Property Map>
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Number
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<Property Map>
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status.
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Number
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Number
    Average disk usage of the primary node over the past minute
    proxyDetail Property Map
    proxy information
    storageAuditLogSize Number
    Space used by audit logs in instance storage
    storageBinLogSize Number
    Binlog space usage in the instance storage
    storageDataSize Number
    Space used by data in instance storage.
    storageErrorLogSize Number
    Space used by error logs in instance storage.
    storageLogSize Number
    Space used by logs in the instance storage
    storageSlowLogSize Number
    Space used by slow logs in instance storage
    storageUse Number
    Storage space used by the instance, in GB
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Number
    CPU size. For example: 1 means 1U.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.

    Look up Existing Instance Resource

    Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address_objects: Optional[Sequence[InstanceAddressObjectArgs]] = None,
            allow_list_ids: Optional[Sequence[str]] = None,
            allow_list_version: Optional[str] = None,
            auto_storage_scaling_config: Optional[InstanceAutoStorageScalingConfigArgs] = None,
            auto_upgrade_minor_version: Optional[str] = None,
            backup_audit_log_size: Optional[int] = None,
            backup_bin_log_size: Optional[int] = None,
            backup_data_size: Optional[int] = None,
            backup_error_log_size: Optional[int] = None,
            backup_free_quota_size: Optional[int] = None,
            backup_log_size: Optional[int] = None,
            backup_slow_log_size: Optional[int] = None,
            backup_use: Optional[float] = None,
            basic_backup_binlog_size: Optional[int] = None,
            basic_backup_data_size: Optional[int] = None,
            charge_detail: Optional[InstanceChargeDetailArgs] = None,
            cpu_num: Optional[int] = None,
            created_time: Optional[str] = None,
            current_kernel_version: Optional[str] = None,
            db_engine_version: Optional[str] = None,
            db_param_group_id: Optional[str] = None,
            db_time_zone: Optional[str] = None,
            deletion_protection: Optional[str] = None,
            disaster_recovery_instances: Optional[Sequence[InstanceDisasterRecoveryInstanceArgs]] = None,
            dr_dts_task_id: Optional[str] = None,
            dr_dts_task_name: Optional[str] = None,
            dr_dts_task_status: Optional[str] = None,
            dr_seconds_behind_master: Optional[int] = None,
            endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
            global_read_only: Optional[bool] = None,
            has_disaster_recovery_instances: Optional[bool] = None,
            has_green_instance: Optional[bool] = None,
            instance_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_status: Optional[str] = None,
            instance_type: Optional[str] = None,
            lower_case_table_names: Optional[str] = None,
            maintenance_window: Optional[InstanceMaintenanceWindowArgs] = None,
            master_instance_id: Optional[str] = None,
            master_instance_name: Optional[str] = None,
            memory: Optional[int] = None,
            node_cpu_used_percentage: Optional[float] = None,
            node_memory_used_percentage: Optional[float] = None,
            node_number: Optional[str] = None,
            node_space_used_percentage: Optional[float] = None,
            node_spec: Optional[str] = None,
            nodes: Optional[Sequence[InstanceNodeArgs]] = None,
            port: Optional[int] = None,
            project_name: Optional[str] = None,
            proxy_detail: Optional[InstanceProxyDetailArgs] = None,
            storage_audit_log_size: Optional[int] = None,
            storage_bin_log_size: Optional[int] = None,
            storage_data_size: Optional[int] = None,
            storage_error_log_size: Optional[int] = None,
            storage_log_size: Optional[int] = None,
            storage_slow_log_size: Optional[int] = None,
            storage_space: Optional[int] = None,
            storage_type: Optional[str] = None,
            storage_use: Optional[float] = None,
            subnet_id: Optional[str] = None,
            super_account_name: Optional[str] = None,
            super_account_password: Optional[str] = None,
            sync_mode: Optional[str] = None,
            tags: Optional[Sequence[InstanceTagArgs]] = None,
            time_zone: Optional[str] = None,
            updated_time: Optional[str] = None,
            vcpu: Optional[int] = None,
            vpc_id: Optional[str] = None,
            zone_id: Optional[str] = None,
            zone_ids: Optional[Sequence[str]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rdsmysql:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AddressObjects List<Volcengine.InstanceAddressObject>
    AllowListIds List<string>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AllowListVersion string
    Allowlist version
    AutoStorageScalingConfig Volcengine.InstanceAutoStorageScalingConfig
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse double
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    ChargeDetail Volcengine.InstanceChargeDetail
    Billing method
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    DisasterRecoveryInstances List<Volcengine.InstanceDisasterRecoveryInstance>
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints List<Volcengine.InstanceEndpoint>
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name.
    InstanceStatus string
    Instance status.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow Volcengine.InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage double
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage double
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage double
    Average disk usage of the primary node over the past minute
    NodeSpec string
    Node specifications.
    Nodes List<Volcengine.InstanceNode>
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    ProjectName string
    Project.
    ProxyDetail Volcengine.InstanceProxyDetail
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    StorageUse double
    Storage space used by the instance, in GB
    SubnetId string
    Subnet ID.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags List<Volcengine.InstanceTag>
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds List<string>
    List of availability zones for each node in the instance.
    AddressObjects []InstanceAddressObjectArgs
    AllowListIds []string
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    AllowListVersion string
    Allowlist version
    AutoStorageScalingConfig InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    AutoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    BackupAuditLogSize int
    Space used by audit logs in backup.
    BackupBinLogSize int
    Space used by binlog logs in backup.
    BackupDataSize int
    Space used by data in backup.
    BackupErrorLogSize int
    Space used by error logs in backups.
    BackupFreeQuotaSize int
    Free backup storage space, in GB
    BackupLogSize int
    Space used by logs in backups.
    BackupSlowLogSize int
    Space used by slow logs in backups.
    BackupUse float64
    Backup space used by the instance, in GB
    BasicBackupBinlogSize int
    Space used by Binlog logs in basic backups.
    BasicBackupDataSize int
    Space used by data in the base backup
    ChargeDetail InstanceChargeDetailArgs
    Billing method
    CpuNum int
    Number of CPU cores for the database proxy service of the instance
    CreatedTime string
    Instance creation local time.
    CurrentKernelVersion string
    Instance kernel minor version.
    DbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    DbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    DbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    DeletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    DisasterRecoveryInstances []InstanceDisasterRecoveryInstanceArgs
    DrDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    DrDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    DrDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    DrSecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    Endpoints []InstanceEndpointArgs
    GlobalReadOnly bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    HasDisasterRecoveryInstances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    HasGreenInstance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name.
    InstanceStatus string
    Instance status.
    InstanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    LowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    MaintenanceWindow InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    MasterInstanceId string
    Primary instance ID
    MasterInstanceName string
    Primary instance name.
    Memory int
    Memory size. Unit: GB.
    NodeCpuUsedPercentage float64
    Average CPU usage of the primary node in the instance over the past minute.
    NodeMemoryUsedPercentage float64
    Average memory usage of the primary node over the past minute
    NodeNumber string
    Number of nodes.
    NodeSpaceUsedPercentage float64
    Average disk usage of the primary node over the past minute
    NodeSpec string
    Node specifications.
    Nodes []InstanceNodeArgs
    Port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    ProjectName string
    Project.
    ProxyDetail InstanceProxyDetailArgs
    proxy information
    StorageAuditLogSize int
    Space used by audit logs in instance storage
    StorageBinLogSize int
    Binlog space usage in the instance storage
    StorageDataSize int
    Space used by data in instance storage.
    StorageErrorLogSize int
    Space used by error logs in instance storage.
    StorageLogSize int
    Space used by logs in the instance storage
    StorageSlowLogSize int
    Space used by slow logs in instance storage
    StorageSpace int
    Total storage space of the instance, in GB
    StorageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    StorageUse float64
    Storage space used by the instance, in GB
    SubnetId string
    Subnet ID.
    SuperAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    SuperAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    SyncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    Tags []InstanceTagArgs
    TimeZone string
    Time zone
    UpdatedTime string
    Instance updates local time.
    Vcpu int
    CPU size. For example: 1 means 1U.
    VpcId string
    VPC (Virtual Private Cloud) ID.
    ZoneId string
    Availability zone of the instance's primary node.
    ZoneIds []string
    List of availability zones for each node in the instance.
    addressObjects List<InstanceAddressObject>
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allowListVersion String
    Allowlist version
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupAuditLogSize Integer
    Space used by audit logs in backup.
    backupBinLogSize Integer
    Space used by binlog logs in backup.
    backupDataSize Integer
    Space used by data in backup.
    backupErrorLogSize Integer
    Space used by error logs in backups.
    backupFreeQuotaSize Integer
    Free backup storage space, in GB
    backupLogSize Integer
    Space used by logs in backups.
    backupSlowLogSize Integer
    Space used by slow logs in backups.
    backupUse Double
    Backup space used by the instance, in GB
    basicBackupBinlogSize Integer
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Integer
    Space used by data in the base backup
    chargeDetail InstanceChargeDetail
    Billing method
    cpuNum Integer
    Number of CPU cores for the database proxy service of the instance
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disasterRecoveryInstances List<InstanceDisasterRecoveryInstance>
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Integer
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<InstanceEndpoint>
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instanceId String
    Instance ID.
    instanceName String
    Instance name.
    instanceStatus String
    Instance status.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Integer
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Double
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Double
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Double
    Average disk usage of the primary node over the past minute
    nodeSpec String
    Node specifications.
    nodes List<InstanceNode>
    port Integer
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    projectName String
    Project.
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize Integer
    Space used by audit logs in instance storage
    storageBinLogSize Integer
    Binlog space usage in the instance storage
    storageDataSize Integer
    Space used by data in instance storage.
    storageErrorLogSize Integer
    Space used by error logs in instance storage.
    storageLogSize Integer
    Space used by logs in the instance storage
    storageSlowLogSize Integer
    Space used by slow logs in instance storage
    storageSpace Integer
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storageUse Double
    Storage space used by the instance, in GB
    subnetId String
    Subnet ID.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<InstanceTag>
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Integer
    CPU size. For example: 1 means 1U.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.
    addressObjects InstanceAddressObject[]
    allowListIds string[]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allowListVersion string
    Allowlist version
    autoStorageScalingConfig InstanceAutoStorageScalingConfig
    Auto scaling configuration
    autoUpgradeMinorVersion string
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupAuditLogSize number
    Space used by audit logs in backup.
    backupBinLogSize number
    Space used by binlog logs in backup.
    backupDataSize number
    Space used by data in backup.
    backupErrorLogSize number
    Space used by error logs in backups.
    backupFreeQuotaSize number
    Free backup storage space, in GB
    backupLogSize number
    Space used by logs in backups.
    backupSlowLogSize number
    Space used by slow logs in backups.
    backupUse number
    Backup space used by the instance, in GB
    basicBackupBinlogSize number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize number
    Space used by data in the base backup
    chargeDetail InstanceChargeDetail
    Billing method
    cpuNum number
    Number of CPU cores for the database proxy service of the instance
    createdTime string
    Instance creation local time.
    currentKernelVersion string
    Instance kernel minor version.
    dbEngineVersion string
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    dbParamGroupId string
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone string
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection string
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disasterRecoveryInstances InstanceDisasterRecoveryInstance[]
    drDtsTaskId string
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName string
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus string
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster number
    Latency between the disaster recovery instance and the primary instance.
    endpoints InstanceEndpoint[]
    globalReadOnly boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    hasDisasterRecoveryInstances boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instanceId string
    Instance ID.
    instanceName string
    Instance name.
    instanceStatus string
    Instance status.
    instanceType string
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames string
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow InstanceMaintenanceWindow
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    masterInstanceId string
    Primary instance ID
    masterInstanceName string
    Primary instance name.
    memory number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage number
    Average memory usage of the primary node over the past minute
    nodeNumber string
    Number of nodes.
    nodeSpaceUsedPercentage number
    Average disk usage of the primary node over the past minute
    nodeSpec string
    Node specifications.
    nodes InstanceNode[]
    port number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    projectName string
    Project.
    proxyDetail InstanceProxyDetail
    proxy information
    storageAuditLogSize number
    Space used by audit logs in instance storage
    storageBinLogSize number
    Binlog space usage in the instance storage
    storageDataSize number
    Space used by data in instance storage.
    storageErrorLogSize number
    Space used by error logs in instance storage.
    storageLogSize number
    Space used by logs in the instance storage
    storageSlowLogSize number
    Space used by slow logs in instance storage
    storageSpace number
    Total storage space of the instance, in GB
    storageType string
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storageUse number
    Storage space used by the instance, in GB
    subnetId string
    Subnet ID.
    superAccountName string
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword string
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode string
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags InstanceTag[]
    timeZone string
    Time zone
    updatedTime string
    Instance updates local time.
    vcpu number
    CPU size. For example: 1 means 1U.
    vpcId string
    VPC (Virtual Private Cloud) ID.
    zoneId string
    Availability zone of the instance's primary node.
    zoneIds string[]
    List of availability zones for each node in the instance.
    address_objects Sequence[InstanceAddressObjectArgs]
    allow_list_ids Sequence[str]
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allow_list_version str
    Allowlist version
    auto_storage_scaling_config InstanceAutoStorageScalingConfigArgs
    Auto scaling configuration
    auto_upgrade_minor_version str
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backup_audit_log_size int
    Space used by audit logs in backup.
    backup_bin_log_size int
    Space used by binlog logs in backup.
    backup_data_size int
    Space used by data in backup.
    backup_error_log_size int
    Space used by error logs in backups.
    backup_free_quota_size int
    Free backup storage space, in GB
    backup_log_size int
    Space used by logs in backups.
    backup_slow_log_size int
    Space used by slow logs in backups.
    backup_use float
    Backup space used by the instance, in GB
    basic_backup_binlog_size int
    Space used by Binlog logs in basic backups.
    basic_backup_data_size int
    Space used by data in the base backup
    charge_detail InstanceChargeDetailArgs
    Billing method
    cpu_num int
    Number of CPU cores for the database proxy service of the instance
    created_time str
    Instance creation local time.
    current_kernel_version str
    Instance kernel minor version.
    db_engine_version str
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    db_param_group_id str
    Parameter template ID. Default value is the default parameter template for the database engine version
    db_time_zone str
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletion_protection str
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disaster_recovery_instances Sequence[InstanceDisasterRecoveryInstanceArgs]
    dr_dts_task_id str
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    dr_dts_task_name str
    Name of synchronization tasks between primary and disaster recovery instances.
    dr_dts_task_status str
    Status of synchronization tasks between primary and disaster recovery instances.
    dr_seconds_behind_master int
    Latency between the disaster recovery instance and the primary instance.
    endpoints Sequence[InstanceEndpointArgs]
    global_read_only bool
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    has_disaster_recovery_instances bool
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    has_green_instance bool
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instance_id str
    Instance ID.
    instance_name str
    Instance name.
    instance_status str
    Instance status.
    instance_type str
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lower_case_table_names str
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenance_window InstanceMaintenanceWindowArgs
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    master_instance_id str
    Primary instance ID
    master_instance_name str
    Primary instance name.
    memory int
    Memory size. Unit: GB.
    node_cpu_used_percentage float
    Average CPU usage of the primary node in the instance over the past minute.
    node_memory_used_percentage float
    Average memory usage of the primary node over the past minute
    node_number str
    Number of nodes.
    node_space_used_percentage float
    Average disk usage of the primary node over the past minute
    node_spec str
    Node specifications.
    nodes Sequence[InstanceNodeArgs]
    port int
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    project_name str
    Project.
    proxy_detail InstanceProxyDetailArgs
    proxy information
    storage_audit_log_size int
    Space used by audit logs in instance storage
    storage_bin_log_size int
    Binlog space usage in the instance storage
    storage_data_size int
    Space used by data in instance storage.
    storage_error_log_size int
    Space used by error logs in instance storage.
    storage_log_size int
    Space used by logs in the instance storage
    storage_slow_log_size int
    Space used by slow logs in instance storage
    storage_space int
    Total storage space of the instance, in GB
    storage_type str
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storage_use float
    Storage space used by the instance, in GB
    subnet_id str
    Subnet ID.
    super_account_name str
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    super_account_password str
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    sync_mode str
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags Sequence[InstanceTagArgs]
    time_zone str
    Time zone
    updated_time str
    Instance updates local time.
    vcpu int
    CPU size. For example: 1 means 1U.
    vpc_id str
    VPC (Virtual Private Cloud) ID.
    zone_id str
    Availability zone of the instance's primary node.
    zone_ids Sequence[str]
    List of availability zones for each node in the instance.
    addressObjects List<Property Map>
    allowListIds List<String>
    Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
    allowListVersion String
    Allowlist version
    autoStorageScalingConfig Property Map
    Auto scaling configuration
    autoUpgradeMinorVersion String
    Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
    backupAuditLogSize Number
    Space used by audit logs in backup.
    backupBinLogSize Number
    Space used by binlog logs in backup.
    backupDataSize Number
    Space used by data in backup.
    backupErrorLogSize Number
    Space used by error logs in backups.
    backupFreeQuotaSize Number
    Free backup storage space, in GB
    backupLogSize Number
    Space used by logs in backups.
    backupSlowLogSize Number
    Space used by slow logs in backups.
    backupUse Number
    Backup space used by the instance, in GB
    basicBackupBinlogSize Number
    Space used by Binlog logs in basic backups.
    basicBackupDataSize Number
    Space used by data in the base backup
    chargeDetail Property Map
    Billing method
    cpuNum Number
    Number of CPU cores for the database proxy service of the instance
    createdTime String
    Instance creation local time.
    currentKernelVersion String
    Instance kernel minor version.
    dbEngineVersion String
    Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
    dbParamGroupId String
    Parameter template ID. Default value is the default parameter template for the database engine version
    dbTimeZone String
    Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
    deletionProtection String
    Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
    disasterRecoveryInstances List<Property Map>
    drDtsTaskId String
    ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
    drDtsTaskName String
    Name of synchronization tasks between primary and disaster recovery instances.
    drDtsTaskStatus String
    Status of synchronization tasks between primary and disaster recovery instances.
    drSecondsBehindMaster Number
    Latency between the disaster recovery instance and the primary instance.
    endpoints List<Property Map>
    globalReadOnly Boolean
    Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
    hasDisasterRecoveryInstances Boolean
    Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
    hasGreenInstance Boolean
    Is the instance in blue-green deployment? Values: true: yes. false: no.
    instanceId String
    Instance ID.
    instanceName String
    Instance name.
    instanceStatus String
    Instance status.
    instanceType String
    Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
    lowerCaseTableNames String
    Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
    maintenanceWindow Property Map
    Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
    masterInstanceId String
    Primary instance ID
    masterInstanceName String
    Primary instance name.
    memory Number
    Memory size. Unit: GB.
    nodeCpuUsedPercentage Number
    Average CPU usage of the primary node in the instance over the past minute.
    nodeMemoryUsedPercentage Number
    Average memory usage of the primary node over the past minute
    nodeNumber String
    Number of nodes.
    nodeSpaceUsedPercentage Number
    Average disk usage of the primary node over the past minute
    nodeSpec String
    Node specifications.
    nodes List<Property Map>
    port Number
    Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
    projectName String
    Project.
    proxyDetail Property Map
    proxy information
    storageAuditLogSize Number
    Space used by audit logs in instance storage
    storageBinLogSize Number
    Binlog space usage in the instance storage
    storageDataSize Number
    Space used by data in instance storage.
    storageErrorLogSize Number
    Space used by error logs in instance storage.
    storageLogSize Number
    Space used by logs in the instance storage
    storageSlowLogSize Number
    Space used by slow logs in instance storage
    storageSpace Number
    Total storage space of the instance, in GB
    storageType String
    Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
    storageUse Number
    Storage space used by the instance, in GB
    subnetId String
    Subnet ID.
    superAccountName String
    High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
    superAccountPassword String
    Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
    syncMode String
    Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
    tags List<Property Map>
    timeZone String
    Time zone
    updatedTime String
    Instance updates local time.
    vcpu Number
    CPU size. For example: 1 means 1U.
    vpcId String
    VPC (Virtual Private Cloud) ID.
    zoneId String
    Availability zone of the instance's primary node.
    zoneIds List<String>
    List of availability zones for each node in the instance.

    Supporting Types

    InstanceAddressObject, InstanceAddressObjectArgs

    DnsVisibility bool
    false: private network resolution (default). true: private and public network resolution.
    Domain string
    Connection domain name
    EipId string
    EIP ID, valid only for Public addresses.
    InternetProtocol string
    IP protocol version. Value: IPv4.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Values: Private: private address. Public: public address
    Port string
    Port
    SubnetId string
    Subnet ID, valid only for Private addresses
    DnsVisibility bool
    false: private network resolution (default). true: private and public network resolution.
    Domain string
    Connection domain name
    EipId string
    EIP ID, valid only for Public addresses.
    InternetProtocol string
    IP protocol version. Value: IPv4.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Values: Private: private address. Public: public address
    Port string
    Port
    SubnetId string
    Subnet ID, valid only for Private addresses
    dnsVisibility Boolean
    false: private network resolution (default). true: private and public network resolution.
    domain String
    Connection domain name
    eipId String
    EIP ID, valid only for Public addresses.
    internetProtocol String
    IP protocol version. Value: IPv4.
    ipAddress String
    IP address.
    networkType String
    Network address type. Values: Private: private address. Public: public address
    port String
    Port
    subnetId String
    Subnet ID, valid only for Private addresses
    dnsVisibility boolean
    false: private network resolution (default). true: private and public network resolution.
    domain string
    Connection domain name
    eipId string
    EIP ID, valid only for Public addresses.
    internetProtocol string
    IP protocol version. Value: IPv4.
    ipAddress string
    IP address.
    networkType string
    Network address type. Values: Private: private address. Public: public address
    port string
    Port
    subnetId string
    Subnet ID, valid only for Private addresses
    dns_visibility bool
    false: private network resolution (default). true: private and public network resolution.
    domain str
    Connection domain name
    eip_id str
    EIP ID, valid only for Public addresses.
    internet_protocol str
    IP protocol version. Value: IPv4.
    ip_address str
    IP address.
    network_type str
    Network address type. Values: Private: private address. Public: public address
    port str
    Port
    subnet_id str
    Subnet ID, valid only for Private addresses
    dnsVisibility Boolean
    false: private network resolution (default). true: private and public network resolution.
    domain String
    Connection domain name
    eipId String
    EIP ID, valid only for Public addresses.
    internetProtocol String
    IP protocol version. Value: IPv4.
    ipAddress String
    IP address.
    networkType String
    Network address type. Values: Private: private address. Public: public address
    port String
    Port
    subnetId String
    Subnet ID, valid only for Private addresses

    InstanceAutoStorageScalingConfig, InstanceAutoStorageScalingConfigArgs

    EnableStorageAutoScale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    StorageThreshold int
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    StorageUpperBound int
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    EnableStorageAutoScale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    StorageThreshold int
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    StorageUpperBound int
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enableStorageAutoScale Boolean
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    storageThreshold Integer
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storageUpperBound Integer
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enableStorageAutoScale boolean
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    storageThreshold number
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storageUpperBound number
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enable_storage_auto_scale bool
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    storage_threshold int
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storage_upper_bound int
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
    enableStorageAutoScale Boolean
    Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
    storageThreshold Number
    Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
    storageUpperBound Number
    Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.

    InstanceChargeDetail, InstanceChargeDetailArgs

    ChargeType string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    AutoRenew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    ChargeEndTime string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    ChargeStartTime string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    ChargeStatus string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    Number int
    Number of instances to purchase. Value range: 1–50. Default: 1
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    OverdueTime string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    Period int
    Purchase duration in prepaid scenarios.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    TempModifyEndTime string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    TempModifyStartTime string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    ChargeType string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    AutoRenew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    ChargeEndTime string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    ChargeStartTime string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    ChargeStatus string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    Number int
    Number of instances to purchase. Value range: 1–50. Default: 1
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    OverdueTime string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    Period int
    Purchase duration in prepaid scenarios.
    PeriodUnit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    TempModifyEndTime string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    TempModifyStartTime string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeType String
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    autoRenew Boolean
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    chargeEndTime String
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    chargeStartTime String
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeStatus String
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number Integer
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdueTime String
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period Integer
    Purchase duration in prepaid scenarios.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    tempModifyEndTime String
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    tempModifyStartTime String
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeType string
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    autoRenew boolean
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    chargeEndTime string
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    chargeStartTime string
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeStatus string
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number number
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdueTime string
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period number
    Purchase duration in prepaid scenarios.
    periodUnit string
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    tempModifyEndTime string
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    tempModifyStartTime string
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    charge_type str
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    auto_renew bool
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    charge_end_time str
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    charge_start_time str
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    charge_status str
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number int
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdue_reclaim_time str
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdue_time str
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period int
    Purchase duration in prepaid scenarios.
    period_unit str
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    temp_modify_end_time str
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    temp_modify_start_time str
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeType String
    Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
    autoRenew Boolean
    Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
    chargeEndTime String
    Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    chargeStartTime String
    Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
    chargeStatus String
    Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
    number Number
    Number of instances to purchase. Value range: 1–50. Default: 1
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
    overdueTime String
    Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    period Number
    Purchase duration in prepaid scenarios.
    periodUnit String
    Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
    tempModifyEndTime String
    Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
    tempModifyStartTime String
    Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ

    InstanceDisasterRecoveryInstance, InstanceDisasterRecoveryInstanceArgs

    DtsTaskId string
    ID of synchronization tasks between primary and disaster recovery instances.
    DtsTaskName string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    DtsTaskStatus string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    InstanceId string
    Disaster recovery instance ID.
    InstanceName string
    Name of disaster recovery instance.
    SecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    DtsTaskId string
    ID of synchronization tasks between primary and disaster recovery instances.
    DtsTaskName string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    DtsTaskStatus string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    InstanceId string
    Disaster recovery instance ID.
    InstanceName string
    Name of disaster recovery instance.
    SecondsBehindMaster int
    Latency between the disaster recovery instance and the primary instance.
    dtsTaskId String
    ID of synchronization tasks between primary and disaster recovery instances.
    dtsTaskName String
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dtsTaskStatus String
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instanceId String
    Disaster recovery instance ID.
    instanceName String
    Name of disaster recovery instance.
    secondsBehindMaster Integer
    Latency between the disaster recovery instance and the primary instance.
    dtsTaskId string
    ID of synchronization tasks between primary and disaster recovery instances.
    dtsTaskName string
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dtsTaskStatus string
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instanceId string
    Disaster recovery instance ID.
    instanceName string
    Name of disaster recovery instance.
    secondsBehindMaster number
    Latency between the disaster recovery instance and the primary instance.
    dts_task_id str
    ID of synchronization tasks between primary and disaster recovery instances.
    dts_task_name str
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dts_task_status str
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instance_id str
    Disaster recovery instance ID.
    instance_name str
    Name of disaster recovery instance.
    seconds_behind_master int
    Latency between the disaster recovery instance and the primary instance.
    dtsTaskId String
    ID of synchronization tasks between primary and disaster recovery instances.
    dtsTaskName String
    Name of the synchronization task between the primary instance and the disaster recovery instance
    dtsTaskStatus String
    Status of synchronization tasks between the primary instance and the disaster recovery instance
    instanceId String
    Disaster recovery instance ID.
    instanceName String
    Name of disaster recovery instance.
    secondsBehindMaster Number
    Latency between the disaster recovery instance and the primary instance.

    InstanceEndpoint, InstanceEndpointArgs

    AutoAddNewNodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    ConnectionInfoTags List<string>
    Connection endpoint tag.
    ConnectionMode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    ConnectionPoolType string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    Description string
    Description of the connection endpoint
    EnableConnectionPersistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    EnableReadOnly string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    EnableReadWriteSplitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    EndpointId string
    Instance connection endpoint ID.
    EndpointName string
    Instance connection endpoint name.
    EndpointType string
    Endpoint type. Value: Custom, custom endpoint.
    IdleConnectionReclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    ImplicitTransSplit bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    MasterNodeRouting bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    MasterProtectorTimeout int
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    MultiStatementsMode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    OverloadProtection bool
    Overload protection enabled. Values: true: yes. false: no
    ReadOnlyNodeDistributionType string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    ReadOnlyNodeMaxDelayTime int
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    ReadOnlyNodeWeights List<Volcengine.InstanceEndpointReadOnlyNodeWeight>
    ReadWriteMode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    AutoAddNewNodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    ConnectionInfoTags []string
    Connection endpoint tag.
    ConnectionMode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    ConnectionPoolType string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    Description string
    Description of the connection endpoint
    EnableConnectionPersistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    EnableReadOnly string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    EnableReadWriteSplitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    EndpointId string
    Instance connection endpoint ID.
    EndpointName string
    Instance connection endpoint name.
    EndpointType string
    Endpoint type. Value: Custom, custom endpoint.
    IdleConnectionReclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    ImplicitTransSplit bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    MasterNodeRouting bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    MasterProtectorTimeout int
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    MultiStatementsMode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    OverloadProtection bool
    Overload protection enabled. Values: true: yes. false: no
    ReadOnlyNodeDistributionType string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    ReadOnlyNodeMaxDelayTime int
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    ReadOnlyNodeWeights []InstanceEndpointReadOnlyNodeWeight
    ReadWriteMode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    autoAddNewNodes String
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connectionInfoTags List<String>
    Connection endpoint tag.
    connectionMode String
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connectionPoolType String
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    description String
    Description of the connection endpoint
    enableConnectionPersistent Boolean
    Enable connection keep-alive. Options: true: yes. false: no
    enableReadOnly String
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enableReadWriteSplitting String
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpointId String
    Instance connection endpoint ID.
    endpointName String
    Instance connection endpoint name.
    endpointType String
    Endpoint type. Value: Custom, custom endpoint.
    idleConnectionReclaim Boolean
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicitTransSplit Boolean
    Whether to enable transaction separation. Values: true: Yes. false: No.
    masterNodeRouting Boolean
    Whether to enable primary node routing. Values: true: Yes. false: No.
    masterProtectorTimeout Integer
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multiStatementsMode String
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overloadProtection Boolean
    Overload protection enabled. Values: true: yes. false: no
    readOnlyNodeDistributionType String
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    readOnlyNodeMaxDelayTime Integer
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    readOnlyNodeWeights List<InstanceEndpointReadOnlyNodeWeight>
    readWriteMode String
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    autoAddNewNodes string
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connectionInfoTags string[]
    Connection endpoint tag.
    connectionMode string
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connectionPoolType string
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    description string
    Description of the connection endpoint
    enableConnectionPersistent boolean
    Enable connection keep-alive. Options: true: yes. false: no
    enableReadOnly string
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enableReadWriteSplitting string
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpointId string
    Instance connection endpoint ID.
    endpointName string
    Instance connection endpoint name.
    endpointType string
    Endpoint type. Value: Custom, custom endpoint.
    idleConnectionReclaim boolean
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicitTransSplit boolean
    Whether to enable transaction separation. Values: true: Yes. false: No.
    masterNodeRouting boolean
    Whether to enable primary node routing. Values: true: Yes. false: No.
    masterProtectorTimeout number
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multiStatementsMode string
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overloadProtection boolean
    Overload protection enabled. Values: true: yes. false: no
    readOnlyNodeDistributionType string
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    readOnlyNodeMaxDelayTime number
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    readOnlyNodeWeights InstanceEndpointReadOnlyNodeWeight[]
    readWriteMode string
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    auto_add_new_nodes str
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connection_info_tags Sequence[str]
    Connection endpoint tag.
    connection_mode str
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connection_pool_type str
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    description str
    Description of the connection endpoint
    enable_connection_persistent bool
    Enable connection keep-alive. Options: true: yes. false: no
    enable_read_only str
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enable_read_write_splitting str
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpoint_id str
    Instance connection endpoint ID.
    endpoint_name str
    Instance connection endpoint name.
    endpoint_type str
    Endpoint type. Value: Custom, custom endpoint.
    idle_connection_reclaim bool
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicit_trans_split bool
    Whether to enable transaction separation. Values: true: Yes. false: No.
    master_node_routing bool
    Whether to enable primary node routing. Values: true: Yes. false: No.
    master_protector_timeout int
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multi_statements_mode str
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overload_protection bool
    Overload protection enabled. Values: true: yes. false: no
    read_only_node_distribution_type str
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    read_only_node_max_delay_time int
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    read_only_node_weights Sequence[InstanceEndpointReadOnlyNodeWeight]
    read_write_mode str
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only
    autoAddNewNodes String
    When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
    connectionInfoTags List<String>
    Connection endpoint tag.
    connectionMode String
    Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
    connectionPoolType String
    Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
    description String
    Description of the connection endpoint
    enableConnectionPersistent Boolean
    Enable connection keep-alive. Options: true: yes. false: no
    enableReadOnly String
    Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
    enableReadWriteSplitting String
    Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
    endpointId String
    Instance connection endpoint ID.
    endpointName String
    Instance connection endpoint name.
    endpointType String
    Endpoint type. Value: Custom, custom endpoint.
    idleConnectionReclaim Boolean
    Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
    implicitTransSplit Boolean
    Whether to enable transaction separation. Values: true: Yes. false: No.
    masterNodeRouting Boolean
    Whether to enable primary node routing. Values: true: Yes. false: No.
    masterProtectorTimeout Number
    Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
    multiStatementsMode String
    Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
    overloadProtection Boolean
    Overload protection enabled. Values: true: yes. false: no
    readOnlyNodeDistributionType String
    Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
    readOnlyNodeMaxDelayTime Number
    Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
    readOnlyNodeWeights List<Property Map>
    readWriteMode String
    Read/write mode: ReadWrite: read/write. ReadOnly: read-only

    InstanceEndpointReadOnlyNodeWeight, InstanceEndpointReadOnlyNodeWeightArgs

    NodeId string
    Read-only nodes require NodeId. Primary nodes do not require it
    NodeType string
    Node type. Primary: primary node. ReadOnly: read-only node
    Weight int
    Node read weight, increments of 100, maximum value is 10000.
    NodeId string
    Read-only nodes require NodeId. Primary nodes do not require it
    NodeType string
    Node type. Primary: primary node. ReadOnly: read-only node
    Weight int
    Node read weight, increments of 100, maximum value is 10000.
    nodeId String
    Read-only nodes require NodeId. Primary nodes do not require it
    nodeType String
    Node type. Primary: primary node. ReadOnly: read-only node
    weight Integer
    Node read weight, increments of 100, maximum value is 10000.
    nodeId string
    Read-only nodes require NodeId. Primary nodes do not require it
    nodeType string
    Node type. Primary: primary node. ReadOnly: read-only node
    weight number
    Node read weight, increments of 100, maximum value is 10000.
    node_id str
    Read-only nodes require NodeId. Primary nodes do not require it
    node_type str
    Node type. Primary: primary node. ReadOnly: read-only node
    weight int
    Node read weight, increments of 100, maximum value is 10000.
    nodeId String
    Read-only nodes require NodeId. Primary nodes do not require it
    nodeType String
    Node type. Primary: primary node. ReadOnly: read-only node
    weight Number
    Node read weight, increments of 100, maximum value is 10000.

    InstanceMaintenanceWindow, InstanceMaintenanceWindowArgs

    DayKind string
    Maintenance cycle granularity. Value: Week.
    DayOfWeeks List<string>
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    DayKind string
    Maintenance cycle granularity. Value: Week.
    DayOfWeeks []string
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    dayKind String
    Maintenance cycle granularity. Value: Week.
    dayOfWeeks List<String>
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    dayKind string
    Maintenance cycle granularity. Value: Week.
    dayOfWeeks string[]
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    day_kind str
    Maintenance cycle granularity. Value: Week.
    day_of_weeks Sequence[str]
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenance_time str
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
    dayKind String
    Maintenance cycle granularity. Value: Week.
    dayOfWeeks List<String>
    Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.

    InstanceNode, InstanceNodeArgs

    NodeSpec string
    Node specification.
    NodeType string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    ZoneId string
    Availability zone ID
    NodeSpec string
    Node specification.
    NodeType string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    ZoneId string
    Availability zone ID
    nodeSpec String
    Node specification.
    nodeType String
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zoneId String
    Availability zone ID
    nodeSpec string
    Node specification.
    nodeType string
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zoneId string
    Availability zone ID
    node_spec str
    Node specification.
    node_type str
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zone_id str
    Availability zone ID
    nodeSpec String
    Node specification.
    nodeType String
    Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.
    zoneId String
    Availability zone ID

    InstanceProxyDetail, InstanceProxyDetailArgs

    DbProxyStatus string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    ProxyResourceInfo Volcengine.InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    DbProxyStatus string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    ProxyResourceInfo InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    dbProxyStatus String
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxyResourceInfo InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    dbProxyStatus string
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxyResourceInfo InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    db_proxy_status str
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxy_resource_info InstanceProxyDetailProxyResourceInfo
    Resource information for the instance's database proxy service
    dbProxyStatus String
    Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
    proxyResourceInfo Property Map
    Resource information for the instance's database proxy service

    InstanceProxyDetailProxyResourceInfo, InstanceProxyDetailProxyResourceInfoArgs

    CurrentProxyCpuNum int
    Current number of cores for the instance database proxy service
    MaxProxyCpuNum int
    Maximum number of cores configurable for database proxy service.
    MinProxyCpuNum int
    Minimum number of CPU cores configurable for the database proxy service
    CurrentProxyCpuNum int
    Current number of cores for the instance database proxy service
    MaxProxyCpuNum int
    Maximum number of cores configurable for database proxy service.
    MinProxyCpuNum int
    Minimum number of CPU cores configurable for the database proxy service
    currentProxyCpuNum Integer
    Current number of cores for the instance database proxy service
    maxProxyCpuNum Integer
    Maximum number of cores configurable for database proxy service.
    minProxyCpuNum Integer
    Minimum number of CPU cores configurable for the database proxy service
    currentProxyCpuNum number
    Current number of cores for the instance database proxy service
    maxProxyCpuNum number
    Maximum number of cores configurable for database proxy service.
    minProxyCpuNum number
    Minimum number of CPU cores configurable for the database proxy service
    current_proxy_cpu_num int
    Current number of cores for the instance database proxy service
    max_proxy_cpu_num int
    Maximum number of cores configurable for database proxy service.
    min_proxy_cpu_num int
    Minimum number of CPU cores configurable for the database proxy service
    currentProxyCpuNum Number
    Current number of cores for the instance database proxy service
    maxProxyCpuNum Number
    Maximum number of cores configurable for database proxy service.
    minProxyCpuNum Number
    Minimum number of CPU cores configurable for the database proxy service

    InstanceTag, InstanceTagArgs

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    Import

    $ pulumi import volcenginecc:rdsmysql/instance:Instance example "instance_id"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.33
    published on Thursday, May 7, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.