Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. getRdsBackups
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.getRdsBackups

Explore with Pulumi AI

flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

Use this data source to get the list of RDS backups.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const test = flexibleengine.getRdsBackups({
    instanceId: instanceId,
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
test = flexibleengine.get_rds_backups(instance_id=instance_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		_, err := flexibleengine.GetRdsBackups(ctx, &flexibleengine.GetRdsBackupsArgs{
			InstanceId: instanceId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var test = Flexibleengine.GetRdsBackups.Invoke(new()
    {
        InstanceId = instanceId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.FlexibleengineFunctions;
import com.pulumi.flexibleengine.inputs.GetRdsBackupsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var test = FlexibleengineFunctions.getRdsBackups(GetRdsBackupsArgs.builder()
            .instanceId(instanceId)
            .build());

    }
}
Copy
configuration:
  instanceId:
    type: dynamic
variables:
  test:
    fn::invoke:
      function: flexibleengine:getRdsBackups
      arguments:
        instanceId: ${instanceId}
Copy

Using getRdsBackups

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRdsBackups(args: GetRdsBackupsArgs, opts?: InvokeOptions): Promise<GetRdsBackupsResult>
function getRdsBackupsOutput(args: GetRdsBackupsOutputArgs, opts?: InvokeOptions): Output<GetRdsBackupsResult>
Copy
def get_rds_backups(backup_id: Optional[str] = None,
                    backup_type: Optional[str] = None,
                    begin_time: Optional[str] = None,
                    end_time: Optional[str] = None,
                    id: Optional[str] = None,
                    instance_id: Optional[str] = None,
                    name: Optional[str] = None,
                    region: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetRdsBackupsResult
def get_rds_backups_output(backup_id: Optional[pulumi.Input[str]] = None,
                    backup_type: Optional[pulumi.Input[str]] = None,
                    begin_time: Optional[pulumi.Input[str]] = None,
                    end_time: Optional[pulumi.Input[str]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    instance_id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    region: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetRdsBackupsResult]
Copy
func GetRdsBackups(ctx *Context, args *GetRdsBackupsArgs, opts ...InvokeOption) (*GetRdsBackupsResult, error)
func GetRdsBackupsOutput(ctx *Context, args *GetRdsBackupsOutputArgs, opts ...InvokeOption) GetRdsBackupsResultOutput
Copy

> Note: This function is named GetRdsBackups in the Go SDK.

public static class GetRdsBackups 
{
    public static Task<GetRdsBackupsResult> InvokeAsync(GetRdsBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetRdsBackupsResult> Invoke(GetRdsBackupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRdsBackupsResult> getRdsBackups(GetRdsBackupsArgs args, InvokeOptions options)
public static Output<GetRdsBackupsResult> getRdsBackups(GetRdsBackupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: flexibleengine:index/getRdsBackups:getRdsBackups
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
Specifies the DB instance ID.
BackupId string
Specifies the backup ID.
BackupType string
Specifies the backup type. The options are as follows:

  • auto: Automated full backup.
  • manual: Manual full backup.
  • fragment: Differential full backup.
  • incremental: Automated incremental backup.
BeginTime string
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
EndTime string
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
Id string
Backup ID.
Name string
Specifies the backup name.
Region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
InstanceId This property is required. string
Specifies the DB instance ID.
BackupId string
Specifies the backup ID.
BackupType string
Specifies the backup type. The options are as follows:

  • auto: Automated full backup.
  • manual: Manual full backup.
  • fragment: Differential full backup.
  • incremental: Automated incremental backup.
BeginTime string
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
EndTime string
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
Id string
Backup ID.
Name string
Specifies the backup name.
Region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
instanceId This property is required. String
Specifies the DB instance ID.
backupId String
Specifies the backup ID.
backupType String
Specifies the backup type. The options are as follows:

  • auto: Automated full backup.
  • manual: Manual full backup.
  • fragment: Differential full backup.
  • incremental: Automated incremental backup.
beginTime String
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
endTime String
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id String
Backup ID.
name String
Specifies the backup name.
region String
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
instanceId This property is required. string
Specifies the DB instance ID.
backupId string
Specifies the backup ID.
backupType string
Specifies the backup type. The options are as follows:

  • auto: Automated full backup.
  • manual: Manual full backup.
  • fragment: Differential full backup.
  • incremental: Automated incremental backup.
beginTime string
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
endTime string
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id string
Backup ID.
name string
Specifies the backup name.
region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
instance_id This property is required. str
Specifies the DB instance ID.
backup_id str
Specifies the backup ID.
backup_type str
Specifies the backup type. The options are as follows:

  • auto: Automated full backup.
  • manual: Manual full backup.
  • fragment: Differential full backup.
  • incremental: Automated incremental backup.
begin_time str
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
end_time str
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id str
Backup ID.
name str
Specifies the backup name.
region str
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
instanceId This property is required. String
Specifies the DB instance ID.
backupId String
Specifies the backup ID.
backupType String
Specifies the backup type. The options are as follows:

  • auto: Automated full backup.
  • manual: Manual full backup.
  • fragment: Differential full backup.
  • incremental: Automated incremental backup.
beginTime String
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
endTime String
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id String
Backup ID.
name String
Specifies the backup name.
region String
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.

getRdsBackups Result

The following output properties are available:

Backups List<GetRdsBackupsBackup>
Backup list. For details, see Data structure of the Backup field. The backups structure is documented below.
Id string
Backup ID.
InstanceId string
RDS instance ID.
Region string
BackupId string
BackupType string
BeginTime string
Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
EndTime string
Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
Name string
Database to be backed up for Microsoft SQL Server.
Backups []GetRdsBackupsBackup
Backup list. For details, see Data structure of the Backup field. The backups structure is documented below.
Id string
Backup ID.
InstanceId string
RDS instance ID.
Region string
BackupId string
BackupType string
BeginTime string
Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
EndTime string
Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
Name string
Database to be backed up for Microsoft SQL Server.
backups List<GetRdsBackupsBackup>
Backup list. For details, see Data structure of the Backup field. The backups structure is documented below.
id String
Backup ID.
instanceId String
RDS instance ID.
region String
backupId String
backupType String
beginTime String
Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
endTime String
Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
name String
Database to be backed up for Microsoft SQL Server.
backups GetRdsBackupsBackup[]
Backup list. For details, see Data structure of the Backup field. The backups structure is documented below.
id string
Backup ID.
instanceId string
RDS instance ID.
region string
backupId string
backupType string
beginTime string
Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
endTime string
Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
name string
Database to be backed up for Microsoft SQL Server.
backups Sequence[GetRdsBackupsBackup]
Backup list. For details, see Data structure of the Backup field. The backups structure is documented below.
id str
Backup ID.
instance_id str
RDS instance ID.
region str
backup_id str
backup_type str
begin_time str
Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
end_time str
Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
name str
Database to be backed up for Microsoft SQL Server.
backups List<Property Map>
Backup list. For details, see Data structure of the Backup field. The backups structure is documented below.
id String
Backup ID.
instanceId String
RDS instance ID.
region String
backupId String
backupType String
beginTime String
Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
endTime String
Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
name String
Database to be backed up for Microsoft SQL Server.

Supporting Types

GetRdsBackupsBackup

AssociatedWithDdm This property is required. bool
Whether a DDM instance has been associated.
BeginTime This property is required. string
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
Databases This property is required. List<GetRdsBackupsBackupDatabase>
Database been backed up. The databases structure is documented below.
Datastores This property is required. List<GetRdsBackupsBackupDatastore>
The database information. The datastore structure is documented below.
EndTime This property is required. string
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
Id This property is required. string
Backup ID.
InstanceId This property is required. string
Specifies the DB instance ID.
Name This property is required. string
Specifies the backup name.
Size This property is required. double
Backup size in KB.
Status This property is required. string
Backup status. The options are as follows:

  • BUILDING: Backup in progress.
  • COMPLETED: Backup completed.
  • FAILED: Backup failed.
  • DELETING: Backup being deleted.
Type This property is required. string
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
AssociatedWithDdm This property is required. bool
Whether a DDM instance has been associated.
BeginTime This property is required. string
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
Databases This property is required. []GetRdsBackupsBackupDatabase
Database been backed up. The databases structure is documented below.
Datastores This property is required. []GetRdsBackupsBackupDatastore
The database information. The datastore structure is documented below.
EndTime This property is required. string
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
Id This property is required. string
Backup ID.
InstanceId This property is required. string
Specifies the DB instance ID.
Name This property is required. string
Specifies the backup name.
Size This property is required. float64
Backup size in KB.
Status This property is required. string
Backup status. The options are as follows:

  • BUILDING: Backup in progress.
  • COMPLETED: Backup completed.
  • FAILED: Backup failed.
  • DELETING: Backup being deleted.
Type This property is required. string
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
associatedWithDdm This property is required. Boolean
Whether a DDM instance has been associated.
beginTime This property is required. String
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
databases This property is required. List<GetRdsBackupsBackupDatabase>
Database been backed up. The databases structure is documented below.
datastores This property is required. List<GetRdsBackupsBackupDatastore>
The database information. The datastore structure is documented below.
endTime This property is required. String
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id This property is required. String
Backup ID.
instanceId This property is required. String
Specifies the DB instance ID.
name This property is required. String
Specifies the backup name.
size This property is required. Double
Backup size in KB.
status This property is required. String
Backup status. The options are as follows:

  • BUILDING: Backup in progress.
  • COMPLETED: Backup completed.
  • FAILED: Backup failed.
  • DELETING: Backup being deleted.
type This property is required. String
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
associatedWithDdm This property is required. boolean
Whether a DDM instance has been associated.
beginTime This property is required. string
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
databases This property is required. GetRdsBackupsBackupDatabase[]
Database been backed up. The databases structure is documented below.
datastores This property is required. GetRdsBackupsBackupDatastore[]
The database information. The datastore structure is documented below.
endTime This property is required. string
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id This property is required. string
Backup ID.
instanceId This property is required. string
Specifies the DB instance ID.
name This property is required. string
Specifies the backup name.
size This property is required. number
Backup size in KB.
status This property is required. string
Backup status. The options are as follows:

  • BUILDING: Backup in progress.
  • COMPLETED: Backup completed.
  • FAILED: Backup failed.
  • DELETING: Backup being deleted.
type This property is required. string
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
associated_with_ddm This property is required. bool
Whether a DDM instance has been associated.
begin_time This property is required. str
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
databases This property is required. Sequence[GetRdsBackupsBackupDatabase]
Database been backed up. The databases structure is documented below.
datastores This property is required. Sequence[GetRdsBackupsBackupDatastore]
The database information. The datastore structure is documented below.
end_time This property is required. str
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id This property is required. str
Backup ID.
instance_id This property is required. str
Specifies the DB instance ID.
name This property is required. str
Specifies the backup name.
size This property is required. float
Backup size in KB.
status This property is required. str
Backup status. The options are as follows:

  • BUILDING: Backup in progress.
  • COMPLETED: Backup completed.
  • FAILED: Backup failed.
  • DELETING: Backup being deleted.
type This property is required. str
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
associatedWithDdm This property is required. Boolean
Whether a DDM instance has been associated.
beginTime This property is required. String
Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".
databases This property is required. List<Property Map>
Database been backed up. The databases structure is documented below.
datastores This property is required. List<Property Map>
The database information. The datastore structure is documented below.
endTime This property is required. String
Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.
id This property is required. String
Backup ID.
instanceId This property is required. String
Specifies the DB instance ID.
name This property is required. String
Specifies the backup name.
size This property is required. Number
Backup size in KB.
status This property is required. String
Backup status. The options are as follows:

  • BUILDING: Backup in progress.
  • COMPLETED: Backup completed.
  • FAILED: Backup failed.
  • DELETING: Backup being deleted.
type This property is required. String
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.

GetRdsBackupsBackupDatabase

Name This property is required. string
Specifies the backup name.
Name This property is required. string
Specifies the backup name.
name This property is required. String
Specifies the backup name.
name This property is required. string
Specifies the backup name.
name This property is required. str
Specifies the backup name.
name This property is required. String
Specifies the backup name.

GetRdsBackupsBackupDatastore

Type This property is required. string
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
Version This property is required. string
DB engine version.
Type This property is required. string
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
Version This property is required. string
DB engine version.
type This property is required. String
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
version This property is required. String
DB engine version.
type This property is required. string
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
version This property is required. string
DB engine version.
type This property is required. str
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
version This property is required. str
DB engine version.
type This property is required. String
DB engine. The value can be: MySQL, PostgreSQL, SQL Server, MariaDB.
version This property is required. String
DB engine version.

Package Details

Repository
flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes
This Pulumi package is based on the flexibleengine Terraform Provider.
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine