import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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. * * ## Import * * ```sh * $ pulumi import volcenginecc:rdsmysql/instance:Instance example "instance_id" * ``` */ export declare class Instance extends pulumi.CustomResource { /** * Get an existing Instance resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance; /** * Returns true if the given object is an instance of Instance. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Instance; readonly addressObjects: pulumi.Output; /** * Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists */ readonly allowListIds: pulumi.Output; /** * Allowlist version */ readonly allowListVersion: pulumi.Output; /** * Auto scaling configuration */ readonly autoStorageScalingConfig: pulumi.Output; /** * Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade. */ readonly autoUpgradeMinorVersion: pulumi.Output; /** * Space used by audit logs in backup. */ readonly backupAuditLogSize: pulumi.Output; /** * Space used by binlog logs in backup. */ readonly backupBinLogSize: pulumi.Output; /** * Space used by data in backup. */ readonly backupDataSize: pulumi.Output; /** * Space used by error logs in backups. */ readonly backupErrorLogSize: pulumi.Output; /** * Free backup storage space, in GB */ readonly backupFreeQuotaSize: pulumi.Output; /** * Space used by logs in backups. */ readonly backupLogSize: pulumi.Output; /** * Space used by slow logs in backups. */ readonly backupSlowLogSize: pulumi.Output; /** * Backup space used by the instance, in GB */ readonly backupUse: pulumi.Output; /** * Space used by Binlog logs in basic backups. */ readonly basicBackupBinlogSize: pulumi.Output; /** * Space used by data in the base backup */ readonly basicBackupDataSize: pulumi.Output; /** * Billing method */ readonly chargeDetail: pulumi.Output; /** * Number of CPU cores for the database proxy service of the instance */ readonly cpuNum: pulumi.Output; /** * Instance creation local time. */ readonly createdTime: pulumi.Output; /** * Instance kernel minor version. */ readonly currentKernelVersion: pulumi.Output; /** * Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version */ readonly dbEngineVersion: pulumi.Output; /** * Parameter template ID. Default value is the default parameter template for the database engine version */ readonly dbParamGroupId: pulumi.Output; /** * Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region. */ readonly dbTimeZone: pulumi.Output; /** * Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value. */ readonly deletionProtection: pulumi.Output; readonly disasterRecoveryInstances: pulumi.Output; /** * ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task. */ readonly drDtsTaskId: pulumi.Output; /** * Name of synchronization tasks between primary and disaster recovery instances. */ readonly drDtsTaskName: pulumi.Output; /** * Status of synchronization tasks between primary and disaster recovery instances. */ readonly drDtsTaskStatus: pulumi.Output; /** * Latency between the disaster recovery instance and the primary instance. */ readonly drSecondsBehindMaster: pulumi.Output; readonly endpoints: pulumi.Output; /** * Enable global read-only mode. Values: true: enabled. false: disabled (default is false) */ readonly globalReadOnly: pulumi.Output; /** * Whether the instance has a disaster recovery instance. Values: true: Yes. false: No. */ readonly hasDisasterRecoveryInstances: pulumi.Output; /** * Is the instance in blue-green deployment? Values: true: yes. false: no. */ readonly hasGreenInstance: pulumi.Output; /** * Instance ID. */ readonly instanceId: pulumi.Output; /** * Instance name. */ readonly instanceName: pulumi.Output; /** * Instance status. */ readonly instanceStatus: pulumi.Output; /** * Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type */ readonly instanceType: pulumi.Output; /** * 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. */ readonly lowerCaseTableNames: pulumi.Output; /** * 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). */ readonly maintenanceWindow: pulumi.Output; /** * Primary instance ID */ readonly masterInstanceId: pulumi.Output; /** * Primary instance name. */ readonly masterInstanceName: pulumi.Output; /** * Memory size. Unit: GB. */ readonly memory: pulumi.Output; /** * Average CPU usage of the primary node in the instance over the past minute. */ readonly nodeCpuUsedPercentage: pulumi.Output; /** * Average memory usage of the primary node over the past minute */ readonly nodeMemoryUsedPercentage: pulumi.Output; /** * Number of nodes. */ readonly nodeNumber: pulumi.Output; /** * Average disk usage of the primary node over the past minute */ readonly nodeSpaceUsedPercentage: pulumi.Output; /** * Node specifications. */ readonly nodeSpec: pulumi.Output; readonly nodes: pulumi.Output; /** * 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. */ readonly port: pulumi.Output; /** * Project. */ readonly projectName: pulumi.Output; /** * proxy information */ readonly proxyDetail: pulumi.Output; /** * Space used by audit logs in instance storage */ readonly storageAuditLogSize: pulumi.Output; /** * Binlog space usage in the instance storage */ readonly storageBinLogSize: pulumi.Output; /** * Space used by data in instance storage. */ readonly storageDataSize: pulumi.Output; /** * Space used by error logs in instance storage. */ readonly storageErrorLogSize: pulumi.Output; /** * Space used by logs in the instance storage */ readonly storageLogSize: pulumi.Output; /** * Space used by slow logs in instance storage */ readonly storageSlowLogSize: pulumi.Output; /** * Total storage space of the instance, in GB */ readonly storageSpace: pulumi.Output; /** * Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk. */ readonly storageType: pulumi.Output; /** * Storage space used by the instance, in GB */ readonly storageUse: pulumi.Output; /** * Subnet ID. */ readonly subnetId: pulumi.Output; /** * High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default. */ readonly superAccountName: pulumi.Output; /** * 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: !@#$%^&*()_+-=,.&?|/. */ readonly superAccountPassword: pulumi.Output; /** * Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous */ readonly syncMode: pulumi.Output; readonly tags: pulumi.Output; /** * Time zone */ readonly timeZone: pulumi.Output; /** * Instance updates local time. */ readonly updatedTime: pulumi.Output; /** * CPU size. For example: 1 means 1U. */ readonly vcpu: pulumi.Output; /** * VPC (Virtual Private Cloud) ID. */ readonly vpcId: pulumi.Output; /** * Availability zone of the instance's primary node. */ readonly zoneId: pulumi.Output; /** * List of availability zones for each node in the instance. */ readonly zoneIds: pulumi.Output; /** * Create a Instance resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Instance resources. */ export interface InstanceState { addressObjects?: pulumi.Input[]>; /** * Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists */ allowListIds?: pulumi.Input[]>; /** * Allowlist version */ allowListVersion?: pulumi.Input; /** * Auto scaling configuration */ autoStorageScalingConfig?: pulumi.Input; /** * Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade. */ autoUpgradeMinorVersion?: pulumi.Input; /** * Space used by audit logs in backup. */ backupAuditLogSize?: pulumi.Input; /** * Space used by binlog logs in backup. */ backupBinLogSize?: pulumi.Input; /** * Space used by data in backup. */ backupDataSize?: pulumi.Input; /** * Space used by error logs in backups. */ backupErrorLogSize?: pulumi.Input; /** * Free backup storage space, in GB */ backupFreeQuotaSize?: pulumi.Input; /** * Space used by logs in backups. */ backupLogSize?: pulumi.Input; /** * Space used by slow logs in backups. */ backupSlowLogSize?: pulumi.Input; /** * Backup space used by the instance, in GB */ backupUse?: pulumi.Input; /** * Space used by Binlog logs in basic backups. */ basicBackupBinlogSize?: pulumi.Input; /** * Space used by data in the base backup */ basicBackupDataSize?: pulumi.Input; /** * Billing method */ chargeDetail?: pulumi.Input; /** * Number of CPU cores for the database proxy service of the instance */ cpuNum?: pulumi.Input; /** * Instance creation local time. */ createdTime?: pulumi.Input; /** * Instance kernel minor version. */ currentKernelVersion?: pulumi.Input; /** * Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version */ dbEngineVersion?: pulumi.Input; /** * Parameter template ID. Default value is the default parameter template for the database engine version */ dbParamGroupId?: pulumi.Input; /** * Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region. */ dbTimeZone?: pulumi.Input; /** * Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value. */ deletionProtection?: pulumi.Input; disasterRecoveryInstances?: pulumi.Input[]>; /** * ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task. */ drDtsTaskId?: pulumi.Input; /** * Name of synchronization tasks between primary and disaster recovery instances. */ drDtsTaskName?: pulumi.Input; /** * Status of synchronization tasks between primary and disaster recovery instances. */ drDtsTaskStatus?: pulumi.Input; /** * Latency between the disaster recovery instance and the primary instance. */ drSecondsBehindMaster?: pulumi.Input; endpoints?: pulumi.Input[]>; /** * Enable global read-only mode. Values: true: enabled. false: disabled (default is false) */ globalReadOnly?: pulumi.Input; /** * Whether the instance has a disaster recovery instance. Values: true: Yes. false: No. */ hasDisasterRecoveryInstances?: pulumi.Input; /** * Is the instance in blue-green deployment? Values: true: yes. false: no. */ hasGreenInstance?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * Instance name. */ instanceName?: pulumi.Input; /** * Instance status. */ instanceStatus?: pulumi.Input; /** * Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type */ instanceType?: pulumi.Input; /** * 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. */ lowerCaseTableNames?: pulumi.Input; /** * 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). */ maintenanceWindow?: pulumi.Input; /** * Primary instance ID */ masterInstanceId?: pulumi.Input; /** * Primary instance name. */ masterInstanceName?: pulumi.Input; /** * Memory size. Unit: GB. */ memory?: pulumi.Input; /** * Average CPU usage of the primary node in the instance over the past minute. */ nodeCpuUsedPercentage?: pulumi.Input; /** * Average memory usage of the primary node over the past minute */ nodeMemoryUsedPercentage?: pulumi.Input; /** * Number of nodes. */ nodeNumber?: pulumi.Input; /** * Average disk usage of the primary node over the past minute */ nodeSpaceUsedPercentage?: pulumi.Input; /** * Node specifications. */ nodeSpec?: pulumi.Input; nodes?: pulumi.Input[]>; /** * 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. */ port?: pulumi.Input; /** * Project. */ projectName?: pulumi.Input; /** * proxy information */ proxyDetail?: pulumi.Input; /** * Space used by audit logs in instance storage */ storageAuditLogSize?: pulumi.Input; /** * Binlog space usage in the instance storage */ storageBinLogSize?: pulumi.Input; /** * Space used by data in instance storage. */ storageDataSize?: pulumi.Input; /** * Space used by error logs in instance storage. */ storageErrorLogSize?: pulumi.Input; /** * Space used by logs in the instance storage */ storageLogSize?: pulumi.Input; /** * Space used by slow logs in instance storage */ storageSlowLogSize?: pulumi.Input; /** * Total storage space of the instance, in GB */ storageSpace?: pulumi.Input; /** * Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk. */ storageType?: pulumi.Input; /** * Storage space used by the instance, in GB */ storageUse?: pulumi.Input; /** * Subnet ID. */ subnetId?: pulumi.Input; /** * High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default. */ superAccountName?: pulumi.Input; /** * 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: !@#$%^&*()_+-=,.&?|/. */ superAccountPassword?: pulumi.Input; /** * Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous */ syncMode?: pulumi.Input; tags?: pulumi.Input[]>; /** * Time zone */ timeZone?: pulumi.Input; /** * Instance updates local time. */ updatedTime?: pulumi.Input; /** * CPU size. For example: 1 means 1U. */ vcpu?: pulumi.Input; /** * VPC (Virtual Private Cloud) ID. */ vpcId?: pulumi.Input; /** * Availability zone of the instance's primary node. */ zoneId?: pulumi.Input; /** * List of availability zones for each node in the instance. */ zoneIds?: pulumi.Input[]>; } /** * The set of arguments for constructing a Instance resource. */ export interface InstanceArgs { /** * Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists */ allowListIds?: pulumi.Input[]>; /** * Auto scaling configuration */ autoStorageScalingConfig?: pulumi.Input; /** * Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade. */ autoUpgradeMinorVersion?: pulumi.Input; /** * Billing method */ chargeDetail: pulumi.Input; /** * Number of CPU cores for the database proxy service of the instance */ cpuNum?: pulumi.Input; /** * Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version */ dbEngineVersion: pulumi.Input; /** * Parameter template ID. Default value is the default parameter template for the database engine version */ dbParamGroupId?: pulumi.Input; /** * Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region. */ dbTimeZone?: pulumi.Input; /** * Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value. */ deletionProtection?: pulumi.Input; /** * Enable global read-only mode. Values: true: enabled. false: disabled (default is false) */ globalReadOnly?: pulumi.Input; /** * Instance name. */ instanceName?: pulumi.Input; /** * Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type */ instanceType?: pulumi.Input; /** * 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. */ lowerCaseTableNames?: pulumi.Input; /** * 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). */ maintenanceWindow?: pulumi.Input; /** * Node specifications. */ nodeSpec?: pulumi.Input; nodes: pulumi.Input[]>; /** * 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. */ port?: pulumi.Input; /** * Project. */ projectName?: pulumi.Input; /** * Total storage space of the instance, in GB */ storageSpace: pulumi.Input; /** * Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk. */ storageType: pulumi.Input; /** * Subnet ID. */ subnetId: pulumi.Input; /** * High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default. */ superAccountName?: pulumi.Input; /** * 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: !@#$%^&*()_+-=,.&?|/. */ superAccountPassword?: pulumi.Input; /** * Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous */ syncMode?: pulumi.Input; tags?: pulumi.Input[]>; /** * VPC (Virtual Private Cloud) ID. */ vpcId: pulumi.Input; }