1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. rds
  5. RdsBackup
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.rds.RdsBackup

alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    Provides a RDS Backup resource.

    Backup object at the instance level or database level.

    For information about RDS Backup and how to use it, see What is Backup.

    NOTE: Available since v1.149.0.

    Example Usage

    Basic Usage

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

const example = new alicloud.rds.Instance("example", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceType: "rds.mysql.t1.small",
    instanceStorage: 30,
    instanceChargeType: "Postpaid",
    dbInstanceStorageType: "local_ssd",
});
const exampleRdsBackup = new alicloud.rds.RdsBackup("example", {dbInstanceId: example.id});

    import pulumi
import pulumi_alicloud as alicloud

example = alicloud.rds.Instance("example",
    engine="MySQL",
    engine_version="5.6",
    instance_type="rds.mysql.t1.small",
    instance_storage=30,
    instance_charge_type="Postpaid",
    db_instance_storage_type="local_ssd")
example_rds_backup = alicloud.rds.RdsBackup("example", db_instance_id=example.id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			Engine:                pulumi.String("MySQL"),
			EngineVersion:         pulumi.String("5.6"),
			InstanceType:          pulumi.String("rds.mysql.t1.small"),
			InstanceStorage:       pulumi.Int(30),
			InstanceChargeType:    pulumi.String("Postpaid"),
			DbInstanceStorageType: pulumi.String("local_ssd"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewRdsBackup(ctx, "example", &rds.RdsBackupArgs{
			DbInstanceId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = new AliCloud.Rds.Instance("example", new()
    {
        Engine = "MySQL",
        EngineVersion = "5.6",
        InstanceType = "rds.mysql.t1.small",
        InstanceStorage = 30,
        InstanceChargeType = "Postpaid",
        DbInstanceStorageType = "local_ssd",
    });

    var exampleRdsBackup = new AliCloud.Rds.RdsBackup("example", new()
    {
        DbInstanceId = example.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.RdsBackup;
import com.pulumi.alicloud.rds.RdsBackupArgs;
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) {
        var example = new Instance("example", InstanceArgs.builder()
            .engine("MySQL")
            .engineVersion("5.6")
            .instanceType("rds.mysql.t1.small")
            .instanceStorage(30)
            .instanceChargeType("Postpaid")
            .dbInstanceStorageType("local_ssd")
            .build());

        var exampleRdsBackup = new RdsBackup("exampleRdsBackup", RdsBackupArgs.builder()
            .dbInstanceId(example.id())
            .build());

    }
}

    resources:
  example:
    type: alicloud:rds:Instance
    properties:
      engine: MySQL
      engineVersion: '5.6'
      instanceType: rds.mysql.t1.small
      instanceStorage: '30'
      instanceChargeType: Postpaid
      dbInstanceStorageType: local_ssd
  exampleRdsBackup:
    type: alicloud:rds:RdsBackup
    name: example
    properties:
      dbInstanceId: ${example.id}

    📚 Need more examples? VIEW MORE EXAMPLES

    Create RdsBackup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RdsBackup(name: string, args: RdsBackupArgs, opts?: CustomResourceOptions);
    @overload
def RdsBackup(resource_name: str,
              args: RdsBackupArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def RdsBackup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              db_instance_id: Optional[str] = None,
              backup_method: Optional[str] = None,
              backup_retention_period: Optional[int] = None,
              backup_strategy: Optional[str] = None,
              backup_type: Optional[str] = None,
              db_name: Optional[str] = None,
              remove_from_state: Optional[bool] = None)
    func NewRdsBackup(ctx *Context, name string, args RdsBackupArgs, opts ...ResourceOption) (*RdsBackup, error)
    public RdsBackup(string name, RdsBackupArgs args, CustomResourceOptions? opts = null)
    public RdsBackup(String name, RdsBackupArgs args)
public RdsBackup(String name, RdsBackupArgs args, CustomResourceOptions options)

    type: alicloud:rds:RdsBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RdsBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RdsBackupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RdsBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RdsBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RdsBackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var rdsBackupResource = new AliCloud.Rds.RdsBackup("rdsBackupResource", new()
{
    DbInstanceId = "string",
    BackupMethod = "string",
    BackupRetentionPeriod = 0,
    BackupStrategy = "string",
    BackupType = "string",
    DbName = "string",
    RemoveFromState = false,
});

    example, err := rds.NewRdsBackup(ctx, "rdsBackupResource", &rds.RdsBackupArgs{
	DbInstanceId:          pulumi.String("string"),
	BackupMethod:          pulumi.String("string"),
	BackupRetentionPeriod: pulumi.Int(0),
	BackupStrategy:        pulumi.String("string"),
	BackupType:            pulumi.String("string"),
	DbName:                pulumi.String("string"),
	RemoveFromState:       pulumi.Bool(false),
})

    var rdsBackupResource = new RdsBackup("rdsBackupResource", RdsBackupArgs.builder()
    .dbInstanceId("string")
    .backupMethod("string")
    .backupRetentionPeriod(0)
    .backupStrategy("string")
    .backupType("string")
    .dbName("string")
    .removeFromState(false)
    .build());

    rds_backup_resource = alicloud.rds.RdsBackup("rdsBackupResource",
    db_instance_id="string",
    backup_method="string",
    backup_retention_period=0,
    backup_strategy="string",
    backup_type="string",
    db_name="string",
    remove_from_state=False)

    const rdsBackupResource = new alicloud.rds.RdsBackup("rdsBackupResource", {
    dbInstanceId: "string",
    backupMethod: "string",
    backupRetentionPeriod: 0,
    backupStrategy: "string",
    backupType: "string",
    dbName: "string",
    removeFromState: false,
});

    type: alicloud:rds:RdsBackup
properties:
    backupMethod: string
    backupRetentionPeriod: 0
    backupStrategy: string
    backupType: string
    dbInstanceId: string
    dbName: string
    removeFromState: false

    RdsBackup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RdsBackup resource accepts the following input properties:

    DbInstanceId string
    The instance ID. You can call DescribeDBInstances to obtain it.
    BackupMethod string

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    BackupRetentionPeriod int

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    BackupStrategy string
    The backup strategy. Valid values:
    BackupType string
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    DbName string

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    RemoveFromState bool
    Remove form state when resource cannot be deleted. Valid values: true and false.
    DbInstanceId string
    The instance ID. You can call DescribeDBInstances to obtain it.
    BackupMethod string

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    BackupRetentionPeriod int

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    BackupStrategy string
    The backup strategy. Valid values:
    BackupType string
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    DbName string

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    RemoveFromState bool
    Remove form state when resource cannot be deleted. Valid values: true and false.
    dbInstanceId String
    The instance ID. You can call DescribeDBInstances to obtain it.
    backupMethod String

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backupRetentionPeriod Integer

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backupStrategy String
    The backup strategy. Valid values:
    backupType String
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    dbName String

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    removeFromState Boolean
    Remove form state when resource cannot be deleted. Valid values: true and false.
    dbInstanceId string
    The instance ID. You can call DescribeDBInstances to obtain it.
    backupMethod string

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backupRetentionPeriod number

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backupStrategy string
    The backup strategy. Valid values:
    backupType string
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    dbName string

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    removeFromState boolean
    Remove form state when resource cannot be deleted. Valid values: true and false.
    db_instance_id str
    The instance ID. You can call DescribeDBInstances to obtain it.
    backup_method str

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backup_retention_period int

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backup_strategy str
    The backup strategy. Valid values:
    backup_type str
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    db_name str

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    remove_from_state bool
    Remove form state when resource cannot be deleted. Valid values: true and false.
    dbInstanceId String
    The instance ID. You can call DescribeDBInstances to obtain it.
    backupMethod String

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backupRetentionPeriod Number

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backupStrategy String
    The backup strategy. Valid values:
    backupType String
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    dbName String

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    removeFromState Boolean
    Remove form state when resource cannot be deleted. Valid values: true and false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RdsBackup resource produces the following output properties:

    BackupId string
    The backup set ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    StoreStatus string
    Indicates whether the backup can be deleted.
    BackupId string
    The backup set ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    StoreStatus string
    Indicates whether the backup can be deleted.
    backupId String
    The backup set ID.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.
    storeStatus String
    Indicates whether the backup can be deleted.
    backupId string
    The backup set ID.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource.
    storeStatus string
    Indicates whether the backup can be deleted.
    backup_id str
    The backup set ID.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the resource.
    store_status str
    Indicates whether the backup can be deleted.
    backupId String
    The backup set ID.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.
    storeStatus String
    Indicates whether the backup can be deleted.

    Look up Existing RdsBackup Resource

    Get an existing RdsBackup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RdsBackupState, opts?: CustomResourceOptions): RdsBackup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_id: Optional[str] = None,
        backup_method: Optional[str] = None,
        backup_retention_period: Optional[int] = None,
        backup_strategy: Optional[str] = None,
        backup_type: Optional[str] = None,
        db_instance_id: Optional[str] = None,
        db_name: Optional[str] = None,
        remove_from_state: Optional[bool] = None,
        status: Optional[str] = None,
        store_status: Optional[str] = None) -> RdsBackup
    func GetRdsBackup(ctx *Context, name string, id IDInput, state *RdsBackupState, opts ...ResourceOption) (*RdsBackup, error)
    public static RdsBackup Get(string name, Input<string> id, RdsBackupState? state, CustomResourceOptions? opts = null)
    public static RdsBackup get(String name, Output<String> id, RdsBackupState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:rds:RdsBackup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BackupId string
    The backup set ID.
    BackupMethod string

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    BackupRetentionPeriod int

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    BackupStrategy string
    The backup strategy. Valid values:
    BackupType string
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    DbInstanceId string
    The instance ID. You can call DescribeDBInstances to obtain it.
    DbName string

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    RemoveFromState bool
    Remove form state when resource cannot be deleted. Valid values: true and false.
    Status string
    The status of the resource.
    StoreStatus string
    Indicates whether the backup can be deleted.
    BackupId string
    The backup set ID.
    BackupMethod string

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    BackupRetentionPeriod int

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    BackupStrategy string
    The backup strategy. Valid values:
    BackupType string
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    DbInstanceId string
    The instance ID. You can call DescribeDBInstances to obtain it.
    DbName string

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    RemoveFromState bool
    Remove form state when resource cannot be deleted. Valid values: true and false.
    Status string
    The status of the resource.
    StoreStatus string
    Indicates whether the backup can be deleted.
    backupId String
    The backup set ID.
    backupMethod String

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backupRetentionPeriod Integer

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backupStrategy String
    The backup strategy. Valid values:
    backupType String
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    dbInstanceId String
    The instance ID. You can call DescribeDBInstances to obtain it.
    dbName String

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    removeFromState Boolean
    Remove form state when resource cannot be deleted. Valid values: true and false.
    status String
    The status of the resource.
    storeStatus String
    Indicates whether the backup can be deleted.
    backupId string
    The backup set ID.
    backupMethod string

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backupRetentionPeriod number

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backupStrategy string
    The backup strategy. Valid values:
    backupType string
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    dbInstanceId string
    The instance ID. You can call DescribeDBInstances to obtain it.
    dbName string

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    removeFromState boolean
    Remove form state when resource cannot be deleted. Valid values: true and false.
    status string
    The status of the resource.
    storeStatus string
    Indicates whether the backup can be deleted.
    backup_id str
    The backup set ID.
    backup_method str

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backup_retention_period int

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backup_strategy str
    The backup strategy. Valid values:
    backup_type str
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    db_instance_id str
    The instance ID. You can call DescribeDBInstances to obtain it.
    db_name str

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    remove_from_state bool
    Remove form state when resource cannot be deleted. Valid values: true and false.
    status str
    The status of the resource.
    store_status str
    Indicates whether the backup can be deleted.
    backupId String
    The backup set ID.
    backupMethod String

    The backup type. Valid values:

    • Logical: logical backup (supported only for MySQL)
    • Physical: physical backup (supported for MySQL, SQL Server, and PostgreSQL)
    • Snapshot: snapshot backup (supported for all database engines)

    Default value: Physical.

    NOTE: * When using logical backup, the database must contain data (the data cannot be empty).

    NOTE: * MariaDB instances support only snapshot backup, but you must specify Physical for this parameter.

    backupRetentionPeriod Number

    When the database engine is SQL Server, BackupStrategy is set to db, BackupMethod is Physical, and BackupType is FullBackup, you can specify the retention period for the backup set. Valid values: 7 to 730 days, or - 1 (permanent retention).

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    backupStrategy String
    The backup strategy. Valid values:
    backupType String
    The backup type. Valid values:

    • FullBackup: full backup
    • IncrementalBackup: incremental backup
    dbInstanceId String
    The instance ID. You can call DescribeDBInstances to obtain it.
    dbName String

    A list of databases, separated by commas (,).

    NOTE: This parameter takes effect only when the BackupStrategy parameter is specified and its value is db.

    NOTE: This parameter is immutable. Changing it after creation has no effect.

    removeFromState Boolean
    Remove form state when resource cannot be deleted. Valid values: true and false.
    status String
    The status of the resource.
    storeStatus String
    Indicates whether the backup can be deleted.

    Import

    RDS Backup can be imported using the id, e.g.

    $ pulumi import alicloud:rds/rdsBackup:RdsBackup example <backup_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Viewing docs for Alibaba Cloud v3.97.0
    published on Saturday, Mar 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud
      Try Pulumi Cloud free. Your team will thank you.