@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
211 lines (210 loc) • 6.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Use this data source to query detailed information of rds postgresql data backups
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
*
* const example = volcengine.rds_postgresql.getDataBackups({
* backupEndTime: "2025-12-15T23:59:59.999Z",
* backupId: "20251214-172343F",
* backupStartTime: "2025-12-01T00:00:00.000Z",
* instanceId: "postgres-72715e0d9f58",
* });
* ```
*/
export declare function getDataBackups(args: GetDataBackupsArgs, opts?: pulumi.InvokeOptions): Promise<GetDataBackupsResult>;
/**
* A collection of arguments for invoking getDataBackups.
*/
export interface GetDataBackupsArgs {
/**
* The name of the database included in the backup set. Only effective when the value of backupMethod is Logical.
*/
backupDatabaseName?: string;
/**
* The description of the backup set.
*/
backupDescription?: string;
/**
* The latest time when the backup is created, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
*/
backupEndTime?: string;
/**
* The ID of the backup.
*/
backupId?: string;
/**
* The method of the backup: Physical, Logical.
*/
backupMethod?: string;
/**
* The scope of the backup: Instance, Database.
*/
backupScope?: string;
/**
* The earliest time when the backup is created, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
*/
backupStartTime?: string;
/**
* The status of the backup: Success, Failed, Running.
*/
backupStatus?: string;
/**
* The type of the backup: Full, Increment.
*/
backupType?: string;
/**
* The creation type of the backup: System, User.
*/
createType?: string;
/**
* The downloadable status of the backup set. NotAllowed: download is not supported. NeedToPrepare: the backup set is in place and needs background preparation for backup. LinkReady: the backup set is ready for download.
*/
downloadStatus?: string;
/**
* The ID of the PostgreSQL instance.
*/
instanceId: string;
/**
* File name where to save data source results.
*/
outputFile?: string;
}
/**
* A collection of values returned by getDataBackups.
*/
export interface GetDataBackupsResult {
readonly backupDatabaseName?: string;
/**
* The description of the backup set.
*/
readonly backupDescription?: string;
/**
* The end time of the backup. The time format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
*/
readonly backupEndTime?: string;
/**
* The ID of the backup.
*/
readonly backupId?: string;
/**
* The method of the backup: Physical, Logical.
*/
readonly backupMethod?: string;
/**
* The scope of the backup: Instance, Database.
*/
readonly backupScope?: string;
/**
* The start time of the backup. The time format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
*/
readonly backupStartTime?: string;
/**
* The status of the backup: Success, Failed, Running.
*/
readonly backupStatus?: string;
/**
* The type of the backup: Full, Increment.
*/
readonly backupType?: string;
/**
* The collection of the query.
*/
readonly backups: outputs.rds_postgresql.GetDataBackupsBackup[];
/**
* The creation type of the backup: System, User.
*/
readonly createType?: string;
/**
* The downloadable status of the backup set.
*/
readonly downloadStatus?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
readonly outputFile?: string;
/**
* The total count of query.
*/
readonly totalCount: number;
}
/**
* Use this data source to query detailed information of rds postgresql data backups
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
*
* const example = volcengine.rds_postgresql.getDataBackups({
* backupEndTime: "2025-12-15T23:59:59.999Z",
* backupId: "20251214-172343F",
* backupStartTime: "2025-12-01T00:00:00.000Z",
* instanceId: "postgres-72715e0d9f58",
* });
* ```
*/
export declare function getDataBackupsOutput(args: GetDataBackupsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDataBackupsResult>;
/**
* A collection of arguments for invoking getDataBackups.
*/
export interface GetDataBackupsOutputArgs {
/**
* The name of the database included in the backup set. Only effective when the value of backupMethod is Logical.
*/
backupDatabaseName?: pulumi.Input<string>;
/**
* The description of the backup set.
*/
backupDescription?: pulumi.Input<string>;
/**
* The latest time when the backup is created, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
*/
backupEndTime?: pulumi.Input<string>;
/**
* The ID of the backup.
*/
backupId?: pulumi.Input<string>;
/**
* The method of the backup: Physical, Logical.
*/
backupMethod?: pulumi.Input<string>;
/**
* The scope of the backup: Instance, Database.
*/
backupScope?: pulumi.Input<string>;
/**
* The earliest time when the backup is created, in the format of yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
*/
backupStartTime?: pulumi.Input<string>;
/**
* The status of the backup: Success, Failed, Running.
*/
backupStatus?: pulumi.Input<string>;
/**
* The type of the backup: Full, Increment.
*/
backupType?: pulumi.Input<string>;
/**
* The creation type of the backup: System, User.
*/
createType?: pulumi.Input<string>;
/**
* The downloadable status of the backup set. NotAllowed: download is not supported. NeedToPrepare: the backup set is in place and needs background preparation for backup. LinkReady: the backup set is ready for download.
*/
downloadStatus?: pulumi.Input<string>;
/**
* The ID of the PostgreSQL instance.
*/
instanceId: pulumi.Input<string>;
/**
* File name where to save data source results.
*/
outputFile?: pulumi.Input<string>;
}