@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
144 lines (143 loc) • 6.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages RDS Mysql database resource within HuaweiCloud.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const instanceId = config.requireObject("instanceId");
* const test = new huaweicloud.rds.MysqlDatabase("test", {
* instanceId: instanceId,
* characterSet: "utf8",
* description: "test database",
* });
* ```
*
* ## Import
*
* RDS database can be imported using the `instance id` and `name` separated by slash, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Rds/mysqlDatabase:MysqlDatabase database_1 <instance_id>/<name>
* ```
*/
export declare class MysqlDatabase extends pulumi.CustomResource {
/**
* Get an existing MysqlDatabase 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<pulumi.ID>, state?: MysqlDatabaseState, opts?: pulumi.CustomResourceOptions): MysqlDatabase;
/**
* Returns true if the given object is an instance of MysqlDatabase. 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 MysqlDatabase;
/**
* Specifies the character set used by the database, For example **utf8**,
* **gbk**, **ascii**, etc. Changing this will create a new resource.
*/
readonly characterSet: pulumi.Output<string>;
/**
* Specifies the database description. The value can contain `0` to `512` characters.
* This parameter takes effect only for DB instances whose kernel versions are at least **5.6.51.3**, **5.7.33.1**,
* or **8.0.21.4**.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies the RDS instance ID. Changing this will create a new resource.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Specifies the database name. The database name contains `1` to `64`
* characters. The name can only consist of lowercase letters, digits, hyphens (-), underscores (_) and dollar signs
* ($). The total number of hyphens (-) and dollar signs ($) cannot exceed `10`. RDS for **MySQL 8.0** does not
* support dollar signs ($). Changing this will create a new resource.
*/
readonly name: pulumi.Output<string>;
/**
* The region in which to create the RDS database resource. If omitted, the
* provider-level region will be used. Changing this creates a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Create a MysqlDatabase 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: MysqlDatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MysqlDatabase resources.
*/
export interface MysqlDatabaseState {
/**
* Specifies the character set used by the database, For example **utf8**,
* **gbk**, **ascii**, etc. Changing this will create a new resource.
*/
characterSet?: pulumi.Input<string>;
/**
* Specifies the database description. The value can contain `0` to `512` characters.
* This parameter takes effect only for DB instances whose kernel versions are at least **5.6.51.3**, **5.7.33.1**,
* or **8.0.21.4**.
*/
description?: pulumi.Input<string>;
/**
* Specifies the RDS instance ID. Changing this will create a new resource.
*/
instanceId?: pulumi.Input<string>;
/**
* Specifies the database name. The database name contains `1` to `64`
* characters. The name can only consist of lowercase letters, digits, hyphens (-), underscores (_) and dollar signs
* ($). The total number of hyphens (-) and dollar signs ($) cannot exceed `10`. RDS for **MySQL 8.0** does not
* support dollar signs ($). Changing this will create a new resource.
*/
name?: pulumi.Input<string>;
/**
* The region in which to create the RDS database resource. If omitted, the
* provider-level region will be used. Changing this creates a new resource.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MysqlDatabase resource.
*/
export interface MysqlDatabaseArgs {
/**
* Specifies the character set used by the database, For example **utf8**,
* **gbk**, **ascii**, etc. Changing this will create a new resource.
*/
characterSet: pulumi.Input<string>;
/**
* Specifies the database description. The value can contain `0` to `512` characters.
* This parameter takes effect only for DB instances whose kernel versions are at least **5.6.51.3**, **5.7.33.1**,
* or **8.0.21.4**.
*/
description?: pulumi.Input<string>;
/**
* Specifies the RDS instance ID. Changing this will create a new resource.
*/
instanceId: pulumi.Input<string>;
/**
* Specifies the database name. The database name contains `1` to `64`
* characters. The name can only consist of lowercase letters, digits, hyphens (-), underscores (_) and dollar signs
* ($). The total number of hyphens (-) and dollar signs ($) cannot exceed `10`. RDS for **MySQL 8.0** does not
* support dollar signs ($). Changing this will create a new resource.
*/
name?: pulumi.Input<string>;
/**
* The region in which to create the RDS database resource. If omitted, the
* provider-level region will be used. Changing this creates a new resource.
*/
region?: pulumi.Input<string>;
}