@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
184 lines (183 loc) • 6.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage rds postgresql database
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.rds_postgresql.Database("foo", {
* cType: "C",
* collate: "zh_CN.utf8",
* dbName: "acc-test",
* instanceId: "postgres-95*******233",
* owner: "super",
* });
* const cloneExample = new volcengine.rds_postgresql.Database("cloneExample", {
* dataOption: "Metadata",
* dbName: "clone-test",
* instanceId: "postgres-95*******233",
* sourceDbName: "acc-test",
* });
* ```
*
* ## Import
*
* Database can be imported using the instanceId:dbName, e.g.
*
* ```sh
* $ pulumi import volcengine:rds_postgresql/database:Database default postgres-ca7b7019****: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;
/**
* Character classification. Value range: C (default), C.UTF-8, en_US.utf8, zh_CN.utf8, and POSIX.
*/
readonly cType: pulumi.Output<string>;
/**
* Database character set. Currently supported character sets include: utf8, latin1, ascii. Default is utf8.
*/
readonly characterSetName: pulumi.Output<string>;
/**
* The collate of database. Sorting rules. Value range: C (default), C.UTF-8, en_US.utf8, zh_CN.utf8 and POSIX.
*/
readonly collate: pulumi.Output<string>;
/**
* The data option of the new database. Currently only Metadata is supported. This parameter is optional when clone an existing database.
*/
readonly dataOption: pulumi.Output<string | undefined>;
/**
* The name of database.
*/
readonly dbName: pulumi.Output<string>;
/**
* The status of the RDS database.
*/
readonly dbStatus: pulumi.Output<string>;
/**
* The ID of the RDS instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The owner of database.
*/
readonly owner: pulumi.Output<string>;
/**
* The plPgsql option of the new database. Value range: View, Procedure, Function, Trigger. This parameter is optional when clone an existing database.
*/
readonly plpgsqlOptions: pulumi.Output<string[] | undefined>;
/**
* The name of the source database. This parameter is required when clone an existing database.
*/
readonly sourceDbName: pulumi.Output<string | undefined>;
/**
* 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 {
/**
* Character classification. Value range: C (default), C.UTF-8, en_US.utf8, zh_CN.utf8, and POSIX.
*/
cType?: pulumi.Input<string>;
/**
* Database character set. Currently supported character sets include: utf8, latin1, ascii. Default is utf8.
*/
characterSetName?: pulumi.Input<string>;
/**
* The collate of database. Sorting rules. Value range: C (default), C.UTF-8, en_US.utf8, zh_CN.utf8 and POSIX.
*/
collate?: pulumi.Input<string>;
/**
* The data option of the new database. Currently only Metadata is supported. This parameter is optional when clone an existing database.
*/
dataOption?: pulumi.Input<string>;
/**
* The name of database.
*/
dbName?: pulumi.Input<string>;
/**
* The status of the RDS database.
*/
dbStatus?: pulumi.Input<string>;
/**
* The ID of the RDS instance.
*/
instanceId?: pulumi.Input<string>;
/**
* The owner of database.
*/
owner?: pulumi.Input<string>;
/**
* The plPgsql option of the new database. Value range: View, Procedure, Function, Trigger. This parameter is optional when clone an existing database.
*/
plpgsqlOptions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the source database. This parameter is required when clone an existing database.
*/
sourceDbName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Database resource.
*/
export interface DatabaseArgs {
/**
* Character classification. Value range: C (default), C.UTF-8, en_US.utf8, zh_CN.utf8, and POSIX.
*/
cType?: pulumi.Input<string>;
/**
* Database character set. Currently supported character sets include: utf8, latin1, ascii. Default is utf8.
*/
characterSetName?: pulumi.Input<string>;
/**
* The collate of database. Sorting rules. Value range: C (default), C.UTF-8, en_US.utf8, zh_CN.utf8 and POSIX.
*/
collate?: pulumi.Input<string>;
/**
* The data option of the new database. Currently only Metadata is supported. This parameter is optional when clone an existing database.
*/
dataOption?: pulumi.Input<string>;
/**
* The name of database.
*/
dbName: pulumi.Input<string>;
/**
* The ID of the RDS instance.
*/
instanceId: pulumi.Input<string>;
/**
* The owner of database.
*/
owner?: pulumi.Input<string>;
/**
* The plPgsql option of the new database. Value range: View, Procedure, Function, Trigger. This parameter is optional when clone an existing database.
*/
plpgsqlOptions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the source database. This parameter is required when clone an existing database.
*/
sourceDbName?: pulumi.Input<string>;
}