import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Provides a resource to manage rds mysql instance * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@pulumi/volcengine"; * import * as volcengine from "@volcengine/pulumi"; * * const fooZones = volcengine.ecs.getZones({}); * // create vpc * const fooVpc = new volcengine.vpc.Vpc("fooVpc", { * vpcName: "acc-test-vpc", * cidrBlock: "172.16.0.0/16", * dnsServers: [ * "8.8.8.8", * "114.114.114.114", * ], * projectName: "default", * }); * // create subnet * const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", { * subnetName: "acc-test-subnet", * cidrBlock: "172.16.0.0/24", * zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id), * vpcId: fooVpc.id, * }); * // create mysql instance * const fooInstance = new volcengine.rds_mysql.Instance("fooInstance", { * dbEngineVersion: "MySQL_5_7", * nodeSpec: "rds.mysql.1c2g", * primaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id), * secondaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id), * storageSpace: 80, * subnetId: fooSubnet.id, * instanceName: "acc-test-mysql-instance", * lowerCaseTableNames: "1", * projectName: "default", * tags: [{ * key: "k1", * value: "v1", * }], * chargeInfo: { * chargeType: "PostPaid", * }, * parameters: [ * { * parameterName: "auto_increment_increment", * parameterValue: "2", * }, * { * parameterName: "auto_increment_offset", * parameterValue: "5", * }, * ], * }); * // create mysql instance readonly node * const fooInstanceReadonlyNode = new volcengine.rds_mysql.InstanceReadonlyNode("fooInstanceReadonlyNode", { * instanceId: fooInstance.id, * nodeSpec: "rds.mysql.2c4g", * zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id), * }); * // create mysql allow list * const fooAllowlist = new volcengine.rds_mysql.Allowlist("fooAllowlist", { * allowListName: "acc-test-allowlist", * allowListDesc: "acc-test", * allowListType: "IPv4", * allowLists: [ * "192.168.0.0/24", * "192.168.1.0/24", * ], * }); * // associate mysql allow list to mysql instance * const fooAllowlistAssociate = new volcengine.rds_mysql.AllowlistAssociate("fooAllowlistAssociate", { * allowListId: fooAllowlist.id, * instanceId: fooInstance.id, * }); * // create mysql database * const fooDatabase = new volcengine.rds_mysql.Database("fooDatabase", { * dbName: "acc-test-database", * instanceId: fooInstance.id, * }); * ``` * * ## Import * * Rds Mysql Instance can be imported using the id, e.g. * * ```sh * $ pulumi import volcengine:rds_mysql/instance:Instance default mysql-72da4258c2c7 * ``` */ 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; /** * Allow list Ids of the RDS instance. */ readonly allowListIds: pulumi.Output; /** * The version of allow list. */ readonly allowListVersion: pulumi.Output; /** * The instance has used backup space. Unit: GB. */ readonly backupUse: pulumi.Output; /** * Does it support the binlog capability? This parameter is returned only when the database proxy is enabled. Values: * true: Yes. * false: No. */ readonly binlogDump: pulumi.Output; /** * Payment methods. */ readonly chargeDetails: pulumi.Output; /** * Payment methods. */ readonly chargeInfo: pulumi.Output; /** * Connection pool type. Value range: * Direct: Direct connection mode. * Transaction: Transaction-level connection pool (default). */ readonly connectionPoolType: pulumi.Output; /** * Node creation local time. */ readonly createTime: pulumi.Output; /** * Data synchronization mode. */ readonly dataSyncMode: pulumi.Output; /** * Instance type. Value: * MySQL_5_7 * MySQL_8_0. */ readonly dbEngineVersion: pulumi.Output; /** * The running status of the proxy instance. This parameter is returned only when the database proxy is enabled. Values: * Creating: The proxy is being started. * Running: The proxy is running. * Shutdown: The proxy is closed. * Deleting: The proxy is being closed. */ readonly dbProxyStatus: pulumi.Output; /** * Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields. */ readonly dbTimeZone: pulumi.Output; /** * The endpoint info of the RDS instance. */ readonly endpoints: pulumi.Output; /** * Feature status. */ readonly featureStates: pulumi.Output; /** * Whether to enable global read-only. * true: Yes. * false: No. */ readonly globalReadOnly: pulumi.Output; /** * Instance ID. */ readonly instanceId: pulumi.Output; /** * Instance name. Cannot start with a number or a dash * Can only contain Chinese characters, letters, numbers, underscores and dashes * The length is limited between 1 ~ 128. */ readonly instanceName: pulumi.Output; /** * The status of the RDS instance. */ readonly instanceStatus: pulumi.Output; /** * Whether the table name is case sensitive, the default value is 1. * Ranges: * 0: Table names are stored as fixed and table names are case-sensitive. * 1: Table names will be stored in lowercase and table names are not case sensitive. */ readonly lowerCaseTableNames: pulumi.Output; /** * Specify the maintainable time period of the instance when creating the instance. This field is optional. If not set, it defaults to 18:00Z - 21:59Z of every day within a week (that is, 02:00 - 05:59 Beijing time). */ readonly maintenanceWindow: pulumi.Output; /** * Memory size in GB. */ readonly memory: pulumi.Output; /** * Average CPU usage of the instance master node in nearly one minute. */ readonly nodeCpuUsedPercentage: pulumi.Output; /** * Average memory usage of the instance master node in nearly one minute. */ readonly nodeMemoryUsedPercentage: pulumi.Output; /** * The number of nodes. */ readonly nodeNumber: pulumi.Output; /** * Average disk usage of the instance master node in nearly one minute. */ readonly nodeSpaceUsedPercentage: pulumi.Output; /** * The specification of primary node and secondary node. */ readonly nodeSpec: pulumi.Output; /** * Instance node information. */ readonly nodes: pulumi.Output; /** * Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid. */ readonly parameters: pulumi.Output; /** * The available zone of primary node. */ readonly primaryZoneId: pulumi.Output; /** * The project name of the RDS instance. */ readonly projectName: pulumi.Output; /** * The region of the RDS instance. */ readonly regionId: pulumi.Output; /** * The available zone of secondary node. */ readonly secondaryZoneId: pulumi.Output; /** * Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100. */ readonly storageSpace: pulumi.Output; /** * Instance storage type. */ readonly storageType: pulumi.Output; /** * The instance has used storage space. Unit: GB. */ readonly storageUse: pulumi.Output; /** * Subnet ID of the RDS instance. */ readonly subnetId: pulumi.Output; /** * Tags. */ readonly tags: pulumi.Output; /** * Time zone. */ readonly timeZone: pulumi.Output; /** * The update time of the RDS instance. */ readonly updateTime: pulumi.Output; /** * CPU size. */ readonly vCpu: pulumi.Output; /** * The vpc ID of the RDS instance. */ readonly vpcId: pulumi.Output; /** * The available zone of the RDS instance. */ readonly zoneId: pulumi.Output; /** * List of availability zones where each node of the instance is located. */ 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 { /** * Allow list Ids of the RDS instance. */ allowListIds?: pulumi.Input[]>; /** * The version of allow list. */ allowListVersion?: pulumi.Input; /** * The instance has used backup space. Unit: GB. */ backupUse?: pulumi.Input; /** * Does it support the binlog capability? This parameter is returned only when the database proxy is enabled. Values: * true: Yes. * false: No. */ binlogDump?: pulumi.Input; /** * Payment methods. */ chargeDetails?: pulumi.Input[]>; /** * Payment methods. */ chargeInfo?: pulumi.Input; /** * Connection pool type. Value range: * Direct: Direct connection mode. * Transaction: Transaction-level connection pool (default). */ connectionPoolType?: pulumi.Input; /** * Node creation local time. */ createTime?: pulumi.Input; /** * Data synchronization mode. */ dataSyncMode?: pulumi.Input; /** * Instance type. Value: * MySQL_5_7 * MySQL_8_0. */ dbEngineVersion?: pulumi.Input; /** * The running status of the proxy instance. This parameter is returned only when the database proxy is enabled. Values: * Creating: The proxy is being started. * Running: The proxy is running. * Shutdown: The proxy is closed. * Deleting: The proxy is being closed. */ dbProxyStatus?: pulumi.Input; /** * Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields. */ dbTimeZone?: pulumi.Input; /** * The endpoint info of the RDS instance. */ endpoints?: pulumi.Input[]>; /** * Feature status. */ featureStates?: pulumi.Input[]>; /** * Whether to enable global read-only. * true: Yes. * false: No. */ globalReadOnly?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * Instance name. Cannot start with a number or a dash * Can only contain Chinese characters, letters, numbers, underscores and dashes * The length is limited between 1 ~ 128. */ instanceName?: pulumi.Input; /** * The status of the RDS instance. */ instanceStatus?: pulumi.Input; /** * Whether the table name is case sensitive, the default value is 1. * Ranges: * 0: Table names are stored as fixed and table names are case-sensitive. * 1: Table names will be stored in lowercase and table names are not case sensitive. */ lowerCaseTableNames?: pulumi.Input; /** * Specify the maintainable time period of the instance when creating the instance. This field is optional. If not set, it defaults to 18:00Z - 21:59Z of every day within a week (that is, 02:00 - 05:59 Beijing time). */ maintenanceWindow?: pulumi.Input; /** * Memory size in GB. */ memory?: pulumi.Input; /** * Average CPU usage of the instance master node in nearly one minute. */ nodeCpuUsedPercentage?: pulumi.Input; /** * Average memory usage of the instance master node in nearly one minute. */ nodeMemoryUsedPercentage?: pulumi.Input; /** * The number of nodes. */ nodeNumber?: pulumi.Input; /** * Average disk usage of the instance master node in nearly one minute. */ nodeSpaceUsedPercentage?: pulumi.Input; /** * The specification of primary node and secondary node. */ nodeSpec?: pulumi.Input; /** * Instance node information. */ nodes?: pulumi.Input[]>; /** * Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid. */ parameters?: pulumi.Input[]>; /** * The available zone of primary node. */ primaryZoneId?: pulumi.Input; /** * The project name of the RDS instance. */ projectName?: pulumi.Input; /** * The region of the RDS instance. */ regionId?: pulumi.Input; /** * The available zone of secondary node. */ secondaryZoneId?: pulumi.Input; /** * Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100. */ storageSpace?: pulumi.Input; /** * Instance storage type. */ storageType?: pulumi.Input; /** * The instance has used storage space. Unit: GB. */ storageUse?: pulumi.Input; /** * Subnet ID of the RDS instance. */ subnetId?: pulumi.Input; /** * Tags. */ tags?: pulumi.Input[]>; /** * Time zone. */ timeZone?: pulumi.Input; /** * The update time of the RDS instance. */ updateTime?: pulumi.Input; /** * CPU size. */ vCpu?: pulumi.Input; /** * The vpc ID of the RDS instance. */ vpcId?: pulumi.Input; /** * The available zone of the RDS instance. */ zoneId?: pulumi.Input; /** * List of availability zones where each node of the instance is located. */ zoneIds?: pulumi.Input[]>; } /** * The set of arguments for constructing a Instance resource. */ export interface InstanceArgs { /** * Allow list Ids of the RDS instance. */ allowListIds?: pulumi.Input[]>; /** * Payment methods. */ chargeInfo: pulumi.Input; /** * Connection pool type. Value range: * Direct: Direct connection mode. * Transaction: Transaction-level connection pool (default). */ connectionPoolType?: pulumi.Input; /** * Instance type. Value: * MySQL_5_7 * MySQL_8_0. */ dbEngineVersion: pulumi.Input; /** * Time zone. Support UTC -12:00 ~ +13:00. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields. */ dbTimeZone?: pulumi.Input; /** * Instance name. Cannot start with a number or a dash * Can only contain Chinese characters, letters, numbers, underscores and dashes * The length is limited between 1 ~ 128. */ instanceName?: pulumi.Input; /** * Whether the table name is case sensitive, the default value is 1. * Ranges: * 0: Table names are stored as fixed and table names are case-sensitive. * 1: Table names will be stored in lowercase and table names are not case sensitive. */ lowerCaseTableNames?: pulumi.Input; /** * Specify the maintainable time period of the instance when creating the instance. This field is optional. If not set, it defaults to 18:00Z - 21:59Z of every day within a week (that is, 02:00 - 05:59 Beijing time). */ maintenanceWindow?: pulumi.Input; /** * The specification of primary node and secondary node. */ nodeSpec: pulumi.Input; /** * Parameter of the RDS instance. This field can only be added or modified. Deleting this field is invalid. */ parameters?: pulumi.Input[]>; /** * The available zone of primary node. */ primaryZoneId: pulumi.Input; /** * The project name of the RDS instance. */ projectName?: pulumi.Input; /** * The available zone of secondary node. */ secondaryZoneId: pulumi.Input; /** * Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100. */ storageSpace?: pulumi.Input; /** * Subnet ID of the RDS instance. */ subnetId: pulumi.Input; /** * Tags. */ tags?: pulumi.Input[]>; }