bytepluscc.vedbm.Instance

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

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.

DbEngineVersion string

Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7

NodeNumber int

Number of instance nodes. Value range: 2–16.

NodeSpec string

Instance node specification code.

SubnetId string

Subnet ID. The subnet must belong to the selected availability zone.

VpcId string

Private network (VPC) ID.

ZoneIds string

Availability zone ID

ChargeDetail Byteplus.InstanceChargeDetail

Billing details.

DbMinorVersion string

Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.

DeletionProtection string

Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.

InstanceName string

Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.

LowerCaseTableNames string

Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.

MaintenanceWindow Byteplus.InstanceMaintenanceWindow

Instance maintenance window information

Nodes List<Byteplus.InstanceNode>

Number int

Number of instances to create. Range: 1~50. Default: 1

Port int

Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.

PrePaidStorageInGb int

Total prepaid storage capacity, in GiB

ProjectName string

Project name to which the instance belongs.

StorageChargeType string

Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).

SuperAccountName string

Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords

SuperAccountPassword string

Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.

Tags List<Byteplus.InstanceTag>

TemplateId string

Parameter template ID

TimeZone string

Instance time zone. The default time zone for all regions in China is UTC +08:00.

DbEngineVersion string

Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7

NodeNumber int

Number of instance nodes. Value range: 2–16.

NodeSpec string

Instance node specification code.

SubnetId string

Subnet ID. The subnet must belong to the selected availability zone.

VpcId string

Private network (VPC) ID.

ZoneIds string

Availability zone ID

ChargeDetail InstanceChargeDetailArgs

Billing details.

DbMinorVersion string

Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.

DeletionProtection string

Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.

InstanceName string

Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.

LowerCaseTableNames string

Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.

MaintenanceWindow InstanceMaintenanceWindowArgs

Instance maintenance window information

Nodes []InstanceNodeArgs

Number int

Number of instances to create. Range: 1~50. Default: 1

Port int

Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.

PrePaidStorageInGb int

Total prepaid storage capacity, in GiB

ProjectName string

Project name to which the instance belongs.

StorageChargeType string

Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).

SuperAccountName string

Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords

SuperAccountPassword string

Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.

Tags []InstanceTagArgs

TemplateId string

Parameter template ID

TimeZone string

Instance time zone. The default time zone for all regions in China is UTC +08:00.

dbEngineVersion String

Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7

nodeNumber Integer

Number of instance nodes. Value range: 2–16.

nodeSpec String

Instance node specification code.

subnetId String

Subnet ID. The subnet must belong to the selected availability zone.

vpcId String

Private network (VPC) ID.

zoneIds String

Availability zone ID

chargeDetail InstanceChargeDetail

Billing details.

dbMinorVersion String

Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.

deletionProtection String

Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.

instanceName String

Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.

lowerCaseTableNames String

Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.

maintenanceWindow InstanceMaintenanceWindow

Instance maintenance window information

nodes List<InstanceNode>

number Integer

Number of instances to create. Range: 1~50. Default: 1

port Integer

Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.

prePaidStorageInGb Integer

Total prepaid storage capacity, in GiB

projectName String

Project name to which the instance belongs.

storageChargeType String

Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).

superAccountName String

Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords

superAccountPassword String

Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.

tags List<InstanceTag>

templateId String

Parameter template ID

timeZone String

Instance time zone. The default time zone for all regions in China is UTC +08:00.

dbEngineVersion string

Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7

nodeNumber number

Number of instance nodes. Value range: 2–16.

nodeSpec string

Instance node specification code.

subnetId string

Subnet ID. The subnet must belong to the selected availability zone.

vpcId string

Private network (VPC) ID.

zoneIds string

Availability zone ID

chargeDetail InstanceChargeDetail

Billing details.

dbMinorVersion string

Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.

deletionProtection string

Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.

instanceName string

Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.

lowerCaseTableNames string

Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.

maintenanceWindow InstanceMaintenanceWindow

Instance maintenance window information

nodes InstanceNode[]

number number

Number of instances to create. Range: 1~50. Default: 1

port number

Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.

prePaidStorageInGb number

Total prepaid storage capacity, in GiB

projectName string

Project name to which the instance belongs.

storageChargeType string

Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).

superAccountName string

Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords

superAccountPassword string

Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.

tags InstanceTag[]

templateId string

Parameter template ID

timeZone string

Instance time zone. The default time zone for all regions in China is UTC +08:00.

db_engine_version str

Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7

node_number int

Number of instance nodes. Value range: 2–16.

node_spec str

Instance node specification code.

subnet_id str

Subnet ID. The subnet must belong to the selected availability zone.

vpc_id str

Private network (VPC) ID.

zone_ids str

Availability zone ID

charge_detail InstanceChargeDetailArgs

Billing details.

db_minor_version str

Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.

deletion_protection str

Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.

instance_name str

Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.

lower_case_table_names str

Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.

maintenance_window InstanceMaintenanceWindowArgs

Instance maintenance window information

nodes Sequence[InstanceNodeArgs]

number int

Number of instances to create. Range: 1~50. Default: 1

port int

Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.

pre_paid_storage_in_gb int

Total prepaid storage capacity, in GiB

project_name str

Project name to which the instance belongs.

storage_charge_type str

Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).

super_account_name str

Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords

super_account_password str

Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.

tags Sequence[InstanceTagArgs]

template_id str

Parameter template ID

time_zone str

Instance time zone. The default time zone for all regions in China is UTC +08:00.

dbEngineVersion String

Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7

nodeNumber Number

Number of instance nodes. Value range: 2–16.

nodeSpec String

Instance node specification code.

subnetId String

Subnet ID. The subnet must belong to the selected availability zone.

vpcId String

Private network (VPC) ID.

zoneIds String

Availability zone ID

chargeDetail Property Map

Billing details.

dbMinorVersion String

Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.

deletionProtection String

Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.

instanceName String

Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.

lowerCaseTableNames String

Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.

maintenanceWindow Property Map

Instance maintenance window information

nodes List<Property Map>

number Number

Number of instances to create. Range: 1~50. Default: 1

port Number

Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.

prePaidStorageInGb Number

Total prepaid storage capacity, in GiB

projectName String

Project name to which the instance belongs.

storageChargeType String

Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).

superAccountName String

Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords

superAccountPassword String

Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.

tags List<Property Map>

templateId String

Parameter template ID

timeZone String

Instance time zone. The default time zone for all regions in China is UTC +08:00.

CreatedTime string

Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)

DbRevisionVersion string

Instance kernel version.

Endpoints List<Byteplus.InstanceEndpoint>

Id string

The provider-assigned unique ID for this managed resource.

InstanceId string

Instance ID.

InstanceStatus string

Instance status.

SpecFamily string

Instance specification type. Values: General: general purpose. Exclusive: dedicated.

StorageUsedGiB double

Used storage space, in GiB

CreatedTime string

Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)

DbRevisionVersion string

Instance kernel version.

Endpoints []InstanceEndpoint

Id string

The provider-assigned unique ID for this managed resource.

InstanceId string

Instance ID.

InstanceStatus string

Instance status.

SpecFamily string

Instance specification type. Values: General: general purpose. Exclusive: dedicated.

StorageUsedGiB float64

Used storage space, in GiB

createdTime String

Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)

dbRevisionVersion String

Instance kernel version.

endpoints List<InstanceEndpoint>

id String

The provider-assigned unique ID for this managed resource.

instanceId String

Instance ID.

instanceStatus String

Instance status.

specFamily String

Instance specification type. Values: General: general purpose. Exclusive: dedicated.

storageUsedGiB Double

Used storage space, in GiB

createdTime string

Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)

dbRevisionVersion string

Instance kernel version.

endpoints InstanceEndpoint[]

id string

The provider-assigned unique ID for this managed resource.

instanceId string

Instance ID.

instanceStatus string

Instance status.

specFamily string

Instance specification type. Values: General: general purpose. Exclusive: dedicated.

storageUsedGiB number

Used storage space, in GiB

created_time str

Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)

db_revision_version str

Instance kernel version.

endpoints Sequence[InstanceEndpoint]

id str

The provider-assigned unique ID for this managed resource.

instance_id str

Instance ID.

instance_status str

Instance status.

spec_family str

Instance specification type. Values: General: general purpose. Exclusive: dedicated.

storage_used_gi_b float

Used storage space, in GiB

createdTime String

Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)

dbRevisionVersion String

Instance kernel version.

endpoints List<Property Map>

id String

The provider-assigned unique ID for this managed resource.

instanceId String

Instance ID.

instanceStatus String

Instance status.

specFamily String

Instance specification type. Values: General: general purpose. Exclusive: dedicated.

storageUsedGiB Number

Used storage space, in GiB

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.

AutoRenew bool

Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.

ChargeEndTime string

Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

ChargeStartTime string

Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

ChargeStatus string

Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown

ChargeType string

Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription

OverdueReclaimTime string

Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

OverdueTime string

Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

Period int

Purchase duration for prepaid scenarios.

PeriodUnit string

Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

AutoRenew bool

Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.

ChargeEndTime string

Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

ChargeStartTime string

Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

ChargeStatus string

Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown

ChargeType string

Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription

OverdueReclaimTime string

Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

OverdueTime string

Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

Period int

Purchase duration for prepaid scenarios.

PeriodUnit string

Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

autoRenew Boolean

Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.

chargeEndTime String

Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

chargeStartTime String

Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

chargeStatus String

Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown

chargeType String

Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription

overdueReclaimTime String

Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

overdueTime String

Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

period Integer

Purchase duration for prepaid scenarios.

periodUnit String

Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

autoRenew boolean

Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.

chargeEndTime string

Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

chargeStartTime string

Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

chargeStatus string

Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown

chargeType string

Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription

overdueReclaimTime string

Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

overdueTime string

Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

period number

Purchase duration for prepaid scenarios.

periodUnit string

Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

auto_renew bool

Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.

charge_end_time str

Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

charge_start_time str

Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

charge_status str

Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown

charge_type str

Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription

overdue_reclaim_time str

Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

overdue_time str

Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

period int

Purchase duration for prepaid scenarios.

period_unit str

Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

autoRenew Boolean

Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.

chargeEndTime String

Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

chargeStartTime String

Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

chargeStatus String

Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown

chargeType String

Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription

overdueReclaimTime String

Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)

overdueTime String

Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

period Number

Purchase duration for prepaid scenarios.

periodUnit String

Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

Addresses List<Byteplus.InstanceEndpointAddress>

AutoAddNewNodes bool

Whether to allow automatic addition of new nodes. Values: true: yes. false: no.

ConsistLevel string

Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.

ConsistTimeout int

When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us

ConsistTimeoutAction string

Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.

Description string

Address description

DistributedTransaction bool

Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.

EndpointId string

Instance connection endpoint ID.

EndpointName string

Instance connection endpoint name.

EndpointType string

Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.

MasterAcceptReadRequests bool

Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No

NodeIds List<string>

Node list configured for the connection endpoint.

ReadWriteMode string

Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

Addresses []InstanceEndpointAddress

AutoAddNewNodes bool

Whether to allow automatic addition of new nodes. Values: true: yes. false: no.

ConsistLevel string

Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.

ConsistTimeout int

When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us

ConsistTimeoutAction string

Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.

Description string

Address description

DistributedTransaction bool

Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.

EndpointId string

Instance connection endpoint ID.

EndpointName string

Instance connection endpoint name.

EndpointType string

Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.

MasterAcceptReadRequests bool

Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No

NodeIds []string

Node list configured for the connection endpoint.

ReadWriteMode string

Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses List<InstanceEndpointAddress>

autoAddNewNodes Boolean

Whether to allow automatic addition of new nodes. Values: true: yes. false: no.

consistLevel String

Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.

consistTimeout Integer

When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us

consistTimeoutAction String

Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.

description String

Address description

distributedTransaction Boolean

Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.

endpointId String

Instance connection endpoint ID.

endpointName String

Instance connection endpoint name.

endpointType String

Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.

masterAcceptReadRequests Boolean

Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No

nodeIds List<String>

Node list configured for the connection endpoint.

readWriteMode String

Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses InstanceEndpointAddress[]

autoAddNewNodes boolean

Whether to allow automatic addition of new nodes. Values: true: yes. false: no.

consistLevel string

Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.

consistTimeout number

When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us

consistTimeoutAction string

Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.

description string

Address description

distributedTransaction boolean

Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.

endpointId string

Instance connection endpoint ID.

endpointName string

Instance connection endpoint name.

endpointType string

Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.

masterAcceptReadRequests boolean

Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No

nodeIds string[]

Node list configured for the connection endpoint.

readWriteMode string

Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses Sequence[InstanceEndpointAddress]

auto_add_new_nodes bool

Whether to allow automatic addition of new nodes. Values: true: yes. false: no.

consist_level str

Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.

consist_timeout int

When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us

consist_timeout_action str

Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.

description str

Address description

distributed_transaction bool

Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.

endpoint_id str

Instance connection endpoint ID.

endpoint_name str

Instance connection endpoint name.

endpoint_type str

Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.

master_accept_read_requests bool

Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No

node_ids Sequence[str]

Node list configured for the connection endpoint.

read_write_mode str

Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses List<Property Map>

autoAddNewNodes Boolean

Whether to allow automatic addition of new nodes. Values: true: yes. false: no.

consistLevel String

Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.

consistTimeout Number

When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us

consistTimeoutAction String

Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.

description String

Address description

distributedTransaction Boolean

Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.

endpointId String

Instance connection endpoint ID.

endpointName String

Instance connection endpoint name.

endpointType String

Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.

masterAcceptReadRequests Boolean

Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No

nodeIds List<String>

Node list configured for the connection endpoint.

readWriteMode String

Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

DnsVisibility bool

Parsing method. The current return value can only be false.

Domain string

Instance private access domain name.

EipId string

Public network ID.

IpAddress string

IP address.

NetworkType string

Network type: Private: private network VPC. Public: public access.

Port string

Instance private network access port.

SubnetId string

Subnet ID. The subnet must belong to the selected availability zone.

DnsVisibility bool

Parsing method. The current return value can only be false.

Domain string

Instance private access domain name.

EipId string

Public network ID.

IpAddress string

IP address.

NetworkType string

Network type: Private: private network VPC. Public: public access.

Port string

Instance private network access port.

SubnetId string

Subnet ID. The subnet must belong to the selected availability zone.

dnsVisibility Boolean

Parsing method. The current return value can only be false.

domain String

Instance private access domain name.

eipId String

Public network ID.

ipAddress String

IP address.

networkType String

Network type: Private: private network VPC. Public: public access.

port String

Instance private network access port.

subnetId String

Subnet ID. The subnet must belong to the selected availability zone.

dnsVisibility boolean

Parsing method. The current return value can only be false.

domain string

Instance private access domain name.

eipId string

Public network ID.

ipAddress string

IP address.

networkType string

Network type: Private: private network VPC. Public: public access.

port string

Instance private network access port.

subnetId string

Subnet ID. The subnet must belong to the selected availability zone.

dns_visibility bool

Parsing method. The current return value can only be false.

domain str

Instance private access domain name.

eip_id str

Public network ID.

ip_address str

IP address.

network_type str

Network type: Private: private network VPC. Public: public access.

port str

Instance private network access port.

subnet_id str

Subnet ID. The subnet must belong to the selected availability zone.

dnsVisibility Boolean

Parsing method. The current return value can only be false.

domain String

Instance private access domain name.

eipId String

Public network ID.

ipAddress String

IP address.

networkType String

Network type: Private: private network VPC. Public: public access.

port String

Instance private network access port.

subnetId String

Subnet ID. The subnet must belong to the selected availability zone.

DayKind string

Maintenance cycle granularity. Default value: Week.

DayOfMonths List<int>

Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.

DayOfWeeks List<string>

Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

MaintenanceTime string

Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

DayKind string

Maintenance cycle granularity. Default value: Week.

DayOfMonths []int

Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.

DayOfWeeks []string

Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

MaintenanceTime string

Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

dayKind String

Maintenance cycle granularity. Default value: Week.

dayOfMonths List<Integer>

Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.

dayOfWeeks List<String>

Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

maintenanceTime String

Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

dayKind string

Maintenance cycle granularity. Default value: Week.

dayOfMonths number[]

Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.

dayOfWeeks string[]

Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

maintenanceTime string

Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

day_kind str

Maintenance cycle granularity. Default value: Week.

day_of_months Sequence[int]

Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.

day_of_weeks Sequence[str]

Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

maintenance_time str

Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

dayKind String

Maintenance cycle granularity. Default value: Week.

dayOfMonths List<Number>

Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.

dayOfWeeks List<String>

Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

maintenanceTime String

Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

FailoverPriority int

Node failover priority. Range: 0~15. Higher values indicate higher priority

NodeType string

Node type. Values: Primary: primary node. ReadOnly: read-only node.

FailoverPriority int

Node failover priority. Range: 0~15. Higher values indicate higher priority

NodeType string

Node type. Values: Primary: primary node. ReadOnly: read-only node.

failoverPriority Integer

Node failover priority. Range: 0~15. Higher values indicate higher priority

nodeType String

Node type. Values: Primary: primary node. ReadOnly: read-only node.

failoverPriority number

Node failover priority. Range: 0~15. Higher values indicate higher priority

nodeType string

Node type. Values: Primary: primary node. ReadOnly: read-only node.

failover_priority int

Node failover priority. Range: 0~15. Higher values indicate higher priority

node_type str

Node type. Values: Primary: primary node. ReadOnly: read-only node.

failoverPriority Number

Node failover priority. Range: 0~15. Higher values indicate higher priority

nodeType String

Node type. Values: Primary: primary node. ReadOnly: read-only node.

Key string

User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it

Value string

User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it