@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
161 lines (160 loc) • 6.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage rds mysql database
* ## 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({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-project1",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-subnet-test-2",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* 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",
* lowerCaseTableNames: "1",
* chargeInfo: {
* chargeType: "PostPaid",
* },
* parameters: [
* {
* parameterName: "auto_increment_increment",
* parameterValue: "2",
* },
* {
* parameterName: "auto_increment_offset",
* parameterValue: "4",
* },
* ],
* });
* const fooDatabase = new volcengine.rds_mysql.Database("fooDatabase", {
* dbName: "acc-test",
* instanceId: fooInstance.id,
* dbDesc: "test-update",
* });
* ```
*
* ## Import
*
* Database can be imported using the instanceId:dbName, e.g.
*
* ```sh
* $ pulumi import volcengine:rds_mysql/database:Database default mysql-42b38c769c4b:dbname
* ```
*/
export declare class Database extends pulumi.CustomResource {
/**
* Get an existing Database 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?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database;
/**
* Returns true if the given object is an instance of Database. 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 Database;
/**
* Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
*/
readonly characterSetName: pulumi.Output<string | undefined>;
/**
* The description information of the database, with a length not exceeding 256 characters. This field is optional. If this field is not set, or if this field is set but the length of the description information is 0, then the description information is empty.
*/
readonly dbDesc: pulumi.Output<string | undefined>;
/**
* Name database.
* illustrate:
* Unique name.
* The length is 2~64 characters.
* Start with a letter and end with a letter or number.
* Consists of lowercase letters, numbers, and underscores (_) or dashes (-).
* Database names are disabled [keywords](https://www.volcengine.com/docs/6313/66162).
*/
readonly dbName: pulumi.Output<string>;
/**
* The ID of the RDS instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Create a Database 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: DatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Database resources.
*/
export interface DatabaseState {
/**
* Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
*/
characterSetName?: pulumi.Input<string>;
/**
* The description information of the database, with a length not exceeding 256 characters. This field is optional. If this field is not set, or if this field is set but the length of the description information is 0, then the description information is empty.
*/
dbDesc?: pulumi.Input<string>;
/**
* Name database.
* illustrate:
* Unique name.
* The length is 2~64 characters.
* Start with a letter and end with a letter or number.
* Consists of lowercase letters, numbers, and underscores (_) or dashes (-).
* Database names are disabled [keywords](https://www.volcengine.com/docs/6313/66162).
*/
dbName?: pulumi.Input<string>;
/**
* The ID of the RDS instance.
*/
instanceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Database resource.
*/
export interface DatabaseArgs {
/**
* Database character set. Currently supported character sets include: utf8, utf8mb4, latin1, ascii.
*/
characterSetName?: pulumi.Input<string>;
/**
* The description information of the database, with a length not exceeding 256 characters. This field is optional. If this field is not set, or if this field is set but the length of the description information is 0, then the description information is empty.
*/
dbDesc?: pulumi.Input<string>;
/**
* Name database.
* illustrate:
* Unique name.
* The length is 2~64 characters.
* Start with a letter and end with a letter or number.
* Consists of lowercase letters, numbers, and underscores (_) or dashes (-).
* Database names are disabled [keywords](https://www.volcengine.com/docs/6313/66162).
*/
dbName: pulumi.Input<string>;
/**
* The ID of the RDS instance.
*/
instanceId: pulumi.Input<string>;
}