@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
129 lines (128 loc) • 3.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "../types";
/**
* Use this data source to get the list of RDS PostgreSQL databases.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as huaweicloud from "@pulumi/huaweicloud";
*
* const config = new pulumi.Config();
* const instanceId = config.requireObject("instanceId");
* const test = huaweicloud.Rds.getPgDatabases({
* instanceId: instanceId,
* });
* ```
*/
export declare function getPgDatabases(args: GetPgDatabasesArgs, opts?: pulumi.InvokeOptions): Promise<GetPgDatabasesResult>;
/**
* A collection of arguments for invoking getPgDatabases.
*/
export interface GetPgDatabasesArgs {
/**
* Specifies the character set used by the database.
* For details, see [documentation](https://www.postgresql.org/docs/16/infoschema-character-sets.html).
*/
characterSet?: string;
/**
* Specifies the PostgreSQL instance ID.
*/
instanceId: string;
/**
* Specifies the database collation.
* For details, see [documentation](https://support.huaweicloud.com/intl/en-us/bestpractice-rds/rds_pg_0017.html).
*/
lcCollate?: string;
/**
* Specifies the database name.
*/
name?: string;
/**
* Specifies the database owner.
*/
owner?: string;
/**
* Specifies the region in which to query the data source.
* If omitted, the provider-level region will be used.
*/
region?: string;
/**
* Specifies the database size, in bytes.
*/
size?: number;
}
/**
* A collection of values returned by getPgDatabases.
*/
export interface GetPgDatabasesResult {
/**
* Indicates the character set used by the database.
*/
readonly characterSet?: string;
/**
* Indicates the database list.
* The databases structure is documented below.
*/
readonly databases: outputs.Rds.GetPgDatabasesDatabase[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
/**
* Indicates the database collation.
*/
readonly lcCollate?: string;
/**
* Indicates the database name.
*/
readonly name?: string;
/**
* Indicates the database owner.
*/
readonly owner?: string;
readonly region: string;
/**
* Indicates the database size, in bytes.
*/
readonly size?: number;
}
export declare function getPgDatabasesOutput(args: GetPgDatabasesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetPgDatabasesResult>;
/**
* A collection of arguments for invoking getPgDatabases.
*/
export interface GetPgDatabasesOutputArgs {
/**
* Specifies the character set used by the database.
* For details, see [documentation](https://www.postgresql.org/docs/16/infoschema-character-sets.html).
*/
characterSet?: pulumi.Input<string>;
/**
* Specifies the PostgreSQL instance ID.
*/
instanceId: pulumi.Input<string>;
/**
* Specifies the database collation.
* For details, see [documentation](https://support.huaweicloud.com/intl/en-us/bestpractice-rds/rds_pg_0017.html).
*/
lcCollate?: pulumi.Input<string>;
/**
* Specifies the database name.
*/
name?: pulumi.Input<string>;
/**
* Specifies the database owner.
*/
owner?: pulumi.Input<string>;
/**
* Specifies the region in which to query the data source.
* If omitted, the provider-level region will be used.
*/
region?: pulumi.Input<string>;
/**
* Specifies the database size, in bytes.
*/
size?: pulumi.Input<number>;
}