1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. RdsBackupV3
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.RdsBackupV3

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for RDS backup rule you can get at documentation portal

    Manages a manual RDS backup.

    Example Usage

    Create a basic RDS backup

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const test = new opentelekomcloud.RdsBackupV3("test", {instanceId: opentelekomcloud_rds_instance_v3.instance.id});
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    test = opentelekomcloud.RdsBackupV3("test", instance_id=opentelekomcloud_rds_instance_v3["instance"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := opentelekomcloud.NewRdsBackupV3(ctx, "test", &opentelekomcloud.RdsBackupV3Args{
    			InstanceId: pulumi.Any(opentelekomcloud_rds_instance_v3.Instance.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Opentelekomcloud.RdsBackupV3("test", new()
        {
            InstanceId = opentelekomcloud_rds_instance_v3.Instance.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.RdsBackupV3;
    import com.pulumi.opentelekomcloud.RdsBackupV3Args;
    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 test = new RdsBackupV3("test", RdsBackupV3Args.builder()
                .instanceId(opentelekomcloud_rds_instance_v3.instance().id())
                .build());
    
        }
    }
    
    resources:
      test:
        type: opentelekomcloud:RdsBackupV3
        properties:
          instanceId: ${opentelekomcloud_rds_instance_v3.instance.id}
    

    Create a specific RDS databases backup for Microsoft SQL Server

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const test = new opentelekomcloud.RdsBackupV3("test", {
        instanceId: opentelekomcloud_rds_instance_v3.instance.id,
        databases: [
            "test",
            "test2",
        ],
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    test = opentelekomcloud.RdsBackupV3("test",
        instance_id=opentelekomcloud_rds_instance_v3["instance"]["id"],
        databases=[
            "test",
            "test2",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := opentelekomcloud.NewRdsBackupV3(ctx, "test", &opentelekomcloud.RdsBackupV3Args{
    			InstanceId: pulumi.Any(opentelekomcloud_rds_instance_v3.Instance.Id),
    			Databases: pulumi.StringArray{
    				pulumi.String("test"),
    				pulumi.String("test2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Opentelekomcloud.RdsBackupV3("test", new()
        {
            InstanceId = opentelekomcloud_rds_instance_v3.Instance.Id,
            Databases = new[]
            {
                "test",
                "test2",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.RdsBackupV3;
    import com.pulumi.opentelekomcloud.RdsBackupV3Args;
    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 test = new RdsBackupV3("test", RdsBackupV3Args.builder()
                .instanceId(opentelekomcloud_rds_instance_v3.instance().id())
                .databases(            
                    "test",
                    "test2")
                .build());
    
        }
    }
    
    resources:
      test:
        type: opentelekomcloud:RdsBackupV3
        properties:
          instanceId: ${opentelekomcloud_rds_instance_v3.instance.id}
          databases:
            - test
            - test2
    

    Create RdsBackupV3 Resource

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

    Constructor syntax

    new RdsBackupV3(name: string, args: RdsBackupV3Args, opts?: CustomResourceOptions);
    @overload
    def RdsBackupV3(resource_name: str,
                    args: RdsBackupV3Args,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def RdsBackupV3(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    instance_id: Optional[str] = None,
                    databases: Optional[Sequence[str]] = None,
                    name: Optional[str] = None,
                    rds_backup_v3_id: Optional[str] = None,
                    timeouts: Optional[RdsBackupV3TimeoutsArgs] = None)
    func NewRdsBackupV3(ctx *Context, name string, args RdsBackupV3Args, opts ...ResourceOption) (*RdsBackupV3, error)
    public RdsBackupV3(string name, RdsBackupV3Args args, CustomResourceOptions? opts = null)
    public RdsBackupV3(String name, RdsBackupV3Args args)
    public RdsBackupV3(String name, RdsBackupV3Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:RdsBackupV3
    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 RdsBackupV3Args
    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 RdsBackupV3Args
    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 RdsBackupV3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RdsBackupV3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RdsBackupV3Args
    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 rdsBackupV3Resource = new Opentelekomcloud.RdsBackupV3("rdsBackupV3Resource", new()
    {
        InstanceId = "string",
        Databases = new[]
        {
            "string",
        },
        Name = "string",
        RdsBackupV3Id = "string",
        Timeouts = new Opentelekomcloud.Inputs.RdsBackupV3TimeoutsArgs
        {
            Create = "string",
        },
    });
    
    example, err := opentelekomcloud.NewRdsBackupV3(ctx, "rdsBackupV3Resource", &opentelekomcloud.RdsBackupV3Args{
    	InstanceId: pulumi.String("string"),
    	Databases: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:          pulumi.String("string"),
    	RdsBackupV3Id: pulumi.String("string"),
    	Timeouts: &opentelekomcloud.RdsBackupV3TimeoutsArgs{
    		Create: pulumi.String("string"),
    	},
    })
    
    var rdsBackupV3Resource = new RdsBackupV3("rdsBackupV3Resource", RdsBackupV3Args.builder()
        .instanceId("string")
        .databases("string")
        .name("string")
        .rdsBackupV3Id("string")
        .timeouts(RdsBackupV3TimeoutsArgs.builder()
            .create("string")
            .build())
        .build());
    
    rds_backup_v3_resource = opentelekomcloud.RdsBackupV3("rdsBackupV3Resource",
        instance_id="string",
        databases=["string"],
        name="string",
        rds_backup_v3_id="string",
        timeouts={
            "create": "string",
        })
    
    const rdsBackupV3Resource = new opentelekomcloud.RdsBackupV3("rdsBackupV3Resource", {
        instanceId: "string",
        databases: ["string"],
        name: "string",
        rdsBackupV3Id: "string",
        timeouts: {
            create: "string",
        },
    });
    
    type: opentelekomcloud:RdsBackupV3
    properties:
        databases:
            - string
        instanceId: string
        name: string
        rdsBackupV3Id: string
        timeouts:
            create: string
    

    RdsBackupV3 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 RdsBackupV3 resource accepts the following input properties:

    InstanceId string
    The ID of the RDS instance to which the backup belongs.
    Databases List<string>
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    Name string
    The name of the backup.
    RdsBackupV3Id string
    The ID of the backup.
    Timeouts RdsBackupV3Timeouts
    InstanceId string
    The ID of the RDS instance to which the backup belongs.
    Databases []string
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    Name string
    The name of the backup.
    RdsBackupV3Id string
    The ID of the backup.
    Timeouts RdsBackupV3TimeoutsArgs
    instanceId String
    The ID of the RDS instance to which the backup belongs.
    databases List<String>
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    name String
    The name of the backup.
    rdsBackupV3Id String
    The ID of the backup.
    timeouts RdsBackupV3Timeouts
    instanceId string
    The ID of the RDS instance to which the backup belongs.
    databases string[]
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    name string
    The name of the backup.
    rdsBackupV3Id string
    The ID of the backup.
    timeouts RdsBackupV3Timeouts
    instance_id str
    The ID of the RDS instance to which the backup belongs.
    databases Sequence[str]
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    name str
    The name of the backup.
    rds_backup_v3_id str
    The ID of the backup.
    timeouts RdsBackupV3TimeoutsArgs
    instanceId String
    The ID of the RDS instance to which the backup belongs.
    databases List<String>
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    name String
    The name of the backup.
    rdsBackupV3Id String
    The ID of the backup.
    timeouts Property Map

    Outputs

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

    BackupId string
    BeginTime string
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size double
    Status string
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    Type string
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    BackupId string
    BeginTime string
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size float64
    Status string
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    Type string
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backupId String
    beginTime String
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    id String
    The provider-assigned unique ID for this managed resource.
    size Double
    status String
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    type String
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backupId string
    beginTime string
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    id string
    The provider-assigned unique ID for this managed resource.
    size number
    status string
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    type string
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backup_id str
    begin_time str
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    id str
    The provider-assigned unique ID for this managed resource.
    size float
    status str
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    type str
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backupId String
    beginTime String
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    id String
    The provider-assigned unique ID for this managed resource.
    size Number
    status String
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    type String
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup

    Look up Existing RdsBackupV3 Resource

    Get an existing RdsBackupV3 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?: RdsBackupV3State, opts?: CustomResourceOptions): RdsBackupV3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_id: Optional[str] = None,
            begin_time: Optional[str] = None,
            databases: Optional[Sequence[str]] = None,
            instance_id: Optional[str] = None,
            name: Optional[str] = None,
            rds_backup_v3_id: Optional[str] = None,
            size: Optional[float] = None,
            status: Optional[str] = None,
            timeouts: Optional[RdsBackupV3TimeoutsArgs] = None,
            type: Optional[str] = None) -> RdsBackupV3
    func GetRdsBackupV3(ctx *Context, name string, id IDInput, state *RdsBackupV3State, opts ...ResourceOption) (*RdsBackupV3, error)
    public static RdsBackupV3 Get(string name, Input<string> id, RdsBackupV3State? state, CustomResourceOptions? opts = null)
    public static RdsBackupV3 get(String name, Output<String> id, RdsBackupV3State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:RdsBackupV3    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
    BeginTime string
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    Databases List<string>
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    InstanceId string
    The ID of the RDS instance to which the backup belongs.
    Name string
    The name of the backup.
    RdsBackupV3Id string
    The ID of the backup.
    Size double
    Status string
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    Timeouts RdsBackupV3Timeouts
    Type string
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    BackupId string
    BeginTime string
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    Databases []string
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    InstanceId string
    The ID of the RDS instance to which the backup belongs.
    Name string
    The name of the backup.
    RdsBackupV3Id string
    The ID of the backup.
    Size float64
    Status string
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    Timeouts RdsBackupV3TimeoutsArgs
    Type string
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backupId String
    beginTime String
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    databases List<String>
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    instanceId String
    The ID of the RDS instance to which the backup belongs.
    name String
    The name of the backup.
    rdsBackupV3Id String
    The ID of the backup.
    size Double
    status String
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    timeouts RdsBackupV3Timeouts
    type String
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backupId string
    beginTime string
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    databases string[]
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    instanceId string
    The ID of the RDS instance to which the backup belongs.
    name string
    The name of the backup.
    rdsBackupV3Id string
    The ID of the backup.
    size number
    status string
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    timeouts RdsBackupV3Timeouts
    type string
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backup_id str
    begin_time str
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    databases Sequence[str]
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    instance_id str
    The ID of the RDS instance to which the backup belongs.
    name str
    The name of the backup.
    rds_backup_v3_id str
    The ID of the backup.
    size float
    status str
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    timeouts RdsBackupV3TimeoutsArgs
    type str
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup
    backupId String
    beginTime String
    Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.
    databases List<String>
    Specifies a list of self-built Microsoft SQL Server databases that are partially backed up. (Only Microsoft SQL Server support partial backups.)
    instanceId String
    The ID of the RDS instance to which the backup belongs.
    name String
    The name of the backup.
    rdsBackupV3Id String
    The ID of the backup.
    size Number
    status String
    Indicates the backup status. Values:

    • BUILDING: Backup in progress
    • COMPLETED: Backup completed
    • FAILED: Backup failed
    • DELETING: Backup being deleted
    timeouts Property Map
    type String
    Indicates the backup type. Values:

    • auto: automated full backup
    • manual: manual full backup
    • fragment: differential full backup
    • incremental: automated incremental backup

    Supporting Types

    RdsBackupV3Timeouts, RdsBackupV3TimeoutsArgs

    Create string
    Create string
    create String
    create string
    create str
    create String

    Import

    RDS backup can be imported using related RDS instance_id and their backup_id, separated by the slashes, e.g.

    bash

    $ pulumi import opentelekomcloud:index/rdsBackupV3:RdsBackupV3 backup <instance_id>/<backup_id>
    

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud