Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Alibaba Cloud Provider
  4. API Docs
  5. mongodb
  6. Backup
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.mongodb.Backup

alicloud logo alicloud logo
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    Provides a Mongodb Backup resource.

    Instance-level or database-level backup objects.

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

    NOTE: Available since v1.292.0.

    Example Usage

    Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const zoneId = config.get("zoneId") || "cn-shanghai-b";
const cidrBlock = config.get("cidrBlock") || "10.0.0.0/24";
const _default = new alicloud.vpc.Network("default", {
    cidrBlock: "10.0.0.0/8",
    vpcName: "bgg-vpc-shanghai-b",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    vpcId: _default.id,
    zoneId: zoneId,
    cidrBlock: cidrBlock,
});
const defaultInstance = new alicloud.mongodb.Instance("default", {
    engineVersion: "5.0",
    storageType: "cloud_essd1",
    vswitchId: defaultSwitch.id,
    dbInstanceStorage: 20,
    vpcId: _default.id,
    dbInstanceClass: "mdb.shard.4x.large.d",
    storageEngine: "WiredTiger",
    networkType: "VPC",
    zoneId: zoneId,
    replicationFactor: 3,
    readonlyReplicas: 0,
});
const defaultBackup = new alicloud.mongodb.Backup("default", {
    backupMethod: "Snapshot",
    dbInstanceId: defaultInstance.id,
    backupRetentionPeriod: 7,
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
zone_id = config.get("zoneId")
if zone_id is None:
    zone_id = "cn-shanghai-b"
cidr_block = config.get("cidrBlock")
if cidr_block is None:
    cidr_block = "10.0.0.0/24"
default = alicloud.vpc.Network("default",
    cidr_block="10.0.0.0/8",
    vpc_name="bgg-vpc-shanghai-b")
default_switch = alicloud.vpc.Switch("default",
    vpc_id=default.id,
    zone_id=zone_id,
    cidr_block=cidr_block)
default_instance = alicloud.mongodb.Instance("default",
    engine_version="5.0",
    storage_type="cloud_essd1",
    vswitch_id=default_switch.id,
    db_instance_storage=20,
    vpc_id=default.id,
    db_instance_class="mdb.shard.4x.large.d",
    storage_engine="WiredTiger",
    network_type="VPC",
    zone_id=zone_id,
    replication_factor=3,
    readonly_replicas=0)
default_backup = alicloud.mongodb.Backup("default",
    backup_method="Snapshot",
    db_instance_id=default_instance.id,
    backup_retention_period=7)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/mongodb"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"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, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		zoneId := "cn-shanghai-b"
		if param := cfg.Get("zoneId"); param != "" {
			zoneId = param
		}
		cidrBlock := "10.0.0.0/24"
		if param := cfg.Get("cidrBlock"); param != "" {
			cidrBlock = param
		}
		_default, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			CidrBlock: pulumi.String("10.0.0.0/8"),
			VpcName:   pulumi.String("bgg-vpc-shanghai-b"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:     _default.ID().ToIDOutput().ToStringOutput(),
			ZoneId:    pulumi.String(zoneId),
			CidrBlock: pulumi.String(cidrBlock),
		})
		if err != nil {
			return err
		}
		defaultInstance, err := mongodb.NewInstance(ctx, "default", &mongodb.InstanceArgs{
			EngineVersion:     pulumi.String("5.0"),
			StorageType:       pulumi.String("cloud_essd1"),
			VswitchId:         defaultSwitch.ID().ToIDOutput().ToStringOutput(),
			DbInstanceStorage: pulumi.Int(20),
			VpcId:             _default.ID().ToIDOutput().ToStringOutput(),
			DbInstanceClass:   pulumi.String("mdb.shard.4x.large.d"),
			StorageEngine:     pulumi.String("WiredTiger"),
			NetworkType:       pulumi.String("VPC"),
			ZoneId:            pulumi.String(zoneId),
			ReplicationFactor: pulumi.Int(3),
			ReadonlyReplicas:  pulumi.Int(0),
		})
		if err != nil {
			return err
		}
		_, err = mongodb.NewBackup(ctx, "default", &mongodb.BackupArgs{
			BackupMethod:          pulumi.String("Snapshot"),
			DbInstanceId:          defaultInstance.ID().ToIDOutput().ToStringOutput(),
			BackupRetentionPeriod: pulumi.Int(7),
		})
		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 config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var zoneId = config.Get("zoneId") ?? "cn-shanghai-b";
    var cidrBlock = config.Get("cidrBlock") ?? "10.0.0.0/24";
    var @default = new AliCloud.Vpc.Network("default", new()
    {
        CidrBlock = "10.0.0.0/8",
        VpcName = "bgg-vpc-shanghai-b",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
    {
        VpcId = @default.Id,
        ZoneId = zoneId,
        CidrBlock = cidrBlock,
    });

    var defaultInstance = new AliCloud.MongoDB.Instance("default", new()
    {
        EngineVersion = "5.0",
        StorageType = "cloud_essd1",
        VswitchId = defaultSwitch.Id,
        DbInstanceStorage = 20,
        VpcId = @default.Id,
        DbInstanceClass = "mdb.shard.4x.large.d",
        StorageEngine = "WiredTiger",
        NetworkType = "VPC",
        ZoneId = zoneId,
        ReplicationFactor = 3,
        ReadonlyReplicas = 0,
    });

    var defaultBackup = new AliCloud.MongoDB.Backup("default", new()
    {
        BackupMethod = "Snapshot",
        DbInstanceId = defaultInstance.Id,
        BackupRetentionPeriod = 7,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.mongodb.Instance;
import com.pulumi.alicloud.mongodb.InstanceArgs;
import com.pulumi.alicloud.mongodb.Backup;
import com.pulumi.alicloud.mongodb.BackupArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 name = config.get("name").orElse("terraform-example");
        final var zoneId = config.get("zoneId").orElse("cn-shanghai-b");
        final var cidrBlock = config.get("cidrBlock").orElse("10.0.0.0/24");
        var default_ = new Network("default", NetworkArgs.builder()
            .cidrBlock("10.0.0.0/8")
            .vpcName("bgg-vpc-shanghai-b")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vpcId(default_.id())
            .zoneId(zoneId)
            .cidrBlock(cidrBlock)
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .engineVersion("5.0")
            .storageType("cloud_essd1")
            .vswitchId(defaultSwitch.id())
            .dbInstanceStorage(20)
            .vpcId(default_.id())
            .dbInstanceClass("mdb.shard.4x.large.d")
            .storageEngine("WiredTiger")
            .networkType("VPC")
            .zoneId(zoneId)
            .replicationFactor(3)
            .readonlyReplicas(0)
            .build());

        var defaultBackup = new Backup("defaultBackup", BackupArgs.builder()
            .backupMethod("Snapshot")
            .dbInstanceId(defaultInstance.id())
            .backupRetentionPeriod(7)
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
  zoneId:
    type: string
    default: cn-shanghai-b
  cidrBlock:
    type: string
    default: 10.0.0.0/24
resources:
  default:
    type: alicloud:vpc:Network
    properties:
      cidrBlock: 10.0.0.0/8
      vpcName: bgg-vpc-shanghai-b
  defaultSwitch:
    type: alicloud:vpc:Switch
    name: default
    properties:
      vpcId: ${default.id}
      zoneId: ${zoneId}
      cidrBlock: ${cidrBlock}
  defaultInstance:
    type: alicloud:mongodb:Instance
    name: default
    properties:
      engineVersion: '5.0'
      storageType: cloud_essd1
      vswitchId: ${defaultSwitch.id}
      dbInstanceStorage: '20'
      vpcId: ${default.id}
      dbInstanceClass: mdb.shard.4x.large.d
      storageEngine: WiredTiger
      networkType: VPC
      zoneId: ${zoneId}
      replicationFactor: '3'
      readonlyReplicas: '0'
  defaultBackup:
    type: alicloud:mongodb:Backup
    name: default
    properties:
      backupMethod: Snapshot
      dbInstanceId: ${defaultInstance.id}
      backupRetentionPeriod: 7

    pulumi {
  required_providers {
    alicloud = {
      source = "pulumi/alicloud"
    }
  }
}

resource "alicloud_vpc_network" "default" {
  cidr_block = "10.0.0.0/8"
  vpc_name   = "bgg-vpc-shanghai-b"
}
resource "alicloud_vpc_switch" "default" {
  vpc_id     = alicloud_vpc_network.default.id
  zone_id    = var.zoneId
  cidr_block = var.cidrBlock
}
resource "alicloud_mongodb_instance" "default" {
  engine_version      = "5.0"
  storage_type        = "cloud_essd1"
  vswitch_id          = alicloud_vpc_switch.default.id
  db_instance_storage = "20"
  vpc_id              = alicloud_vpc_network.default.id
  db_instance_class   = "mdb.shard.4x.large.d"
  storage_engine      = "WiredTiger"
  network_type        = "VPC"
  zone_id             = var.zoneId
  replication_factor  = "3"
  readonly_replicas   = "0"
}
resource "alicloud_mongodb_backup" "default" {
  backup_method           = "Snapshot"
  db_instance_id          = alicloud_mongodb_instance.default.id
  backup_retention_period = 7
}
variable "name" {
  type    = string
  default = "terraform-example"
}
variable "zoneId" {
  type    = string
  default = "cn-shanghai-b"
}
variable "cidrBlock" {
  type    = string
  default = "10.0.0.0/24"
}

    📚 Need more examples? VIEW MORE EXAMPLES

    Create Backup Resource

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

    Constructor syntax

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

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           db_instance_id: Optional[str] = None,
           backup_method: Optional[str] = None,
           backup_retention_period: Optional[int] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

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


    resource "alicloud_mongodb_backup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    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 BackupArgs
    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 BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    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 backupResource = new AliCloud.MongoDB.Backup("backupResource", new()
{
    DbInstanceId = "string",
    BackupMethod = "string",
    BackupRetentionPeriod = 0,
});

    example, err := mongodb.NewBackup(ctx, "backupResource", &mongodb.BackupArgs{
	DbInstanceId:          pulumi.String("string"),
	BackupMethod:          pulumi.String("string"),
	BackupRetentionPeriod: pulumi.Int(0),
})

    resource "alicloud_mongodb_backup" "backupResource" {
  lifecycle {
    create_before_destroy = true
  }
  db_instance_id          = "string"
  backup_method           = "string"
  backup_retention_period = 0
}

    var backupResource = new com.pulumi.alicloud.mongodb.Backup("backupResource", com.pulumi.alicloud.mongodb.BackupArgs.builder()
    .dbInstanceId("string")
    .backupMethod("string")
    .backupRetentionPeriod(0)
    .build());

    backup_resource = alicloud.mongodb.Backup("backupResource",
    db_instance_id="string",
    backup_method="string",
    backup_retention_period=0)

    const backupResource = new alicloud.mongodb.Backup("backupResource", {
    dbInstanceId: "string",
    backupMethod: "string",
    backupRetentionPeriod: 0,
});

    type: alicloud:mongodb:Backup
properties:
    backupMethod: string
    backupRetentionPeriod: 0
    dbInstanceId: string

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

    DbInstanceId string
    The ID of the MongoDB instance.
    BackupMethod string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    BackupRetentionPeriod int
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    DbInstanceId string
    The ID of the MongoDB instance.
    BackupMethod string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    BackupRetentionPeriod int
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    db_instance_id string
    The ID of the MongoDB instance.
    backup_method string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backup_retention_period number
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    dbInstanceId String
    The ID of the MongoDB instance.
    backupMethod String
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backupRetentionPeriod Integer
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    dbInstanceId string
    The ID of the MongoDB instance.
    backupMethod string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backupRetentionPeriod number
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    db_instance_id str
    The ID of the MongoDB instance.
    backup_method str
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backup_retention_period int
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    dbInstanceId String
    The ID of the MongoDB instance.
    backupMethod String
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backupRetentionPeriod Number
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.

    Outputs

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

    BackupDbNames string
    Backup DB Names.
    BackupDownloadUrl string
    Backup Download URL.
    BackupEndTime string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupId string
    Backup Id.
    BackupIntranetDownloadUrl string
    Backup Intranet DownloadURL.
    BackupJobId string
    The backup task ID.
    BackupMode string
    Backup Mode. Valid values: Automated, Manual.
    BackupSize int
    Backup Size in Bytes.
    BackupStartTime string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupType string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource. Valid values: Success, Failed.
    BackupDbNames string
    Backup DB Names.
    BackupDownloadUrl string
    Backup Download URL.
    BackupEndTime string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupId string
    Backup Id.
    BackupIntranetDownloadUrl string
    Backup Intranet DownloadURL.
    BackupJobId string
    The backup task ID.
    BackupMode string
    Backup Mode. Valid values: Automated, Manual.
    BackupSize int
    Backup Size in Bytes.
    BackupStartTime string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupType string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource. Valid values: Success, Failed.
    backup_db_names string
    Backup DB Names.
    backup_download_url string
    Backup Download URL.
    backup_end_time string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_id string
    Backup Id.
    backup_intranet_download_url string
    Backup Intranet DownloadURL.
    backup_job_id string
    The backup task ID.
    backup_mode string
    Backup Mode. Valid values: Automated, Manual.
    backup_size number
    Backup Size in Bytes.
    backup_start_time string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_type string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource. Valid values: Success, Failed.
    backupDbNames String
    Backup DB Names.
    backupDownloadUrl String
    Backup Download URL.
    backupEndTime String
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupId String
    Backup Id.
    backupIntranetDownloadUrl String
    Backup Intranet DownloadURL.
    backupJobId String
    The backup task ID.
    backupMode String
    Backup Mode. Valid values: Automated, Manual.
    backupSize Integer
    Backup Size in Bytes.
    backupStartTime String
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupType String
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource. Valid values: Success, Failed.
    backupDbNames string
    Backup DB Names.
    backupDownloadUrl string
    Backup Download URL.
    backupEndTime string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupId string
    Backup Id.
    backupIntranetDownloadUrl string
    Backup Intranet DownloadURL.
    backupJobId string
    The backup task ID.
    backupMode string
    Backup Mode. Valid values: Automated, Manual.
    backupSize number
    Backup Size in Bytes.
    backupStartTime string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupType string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource. Valid values: Success, Failed.
    backup_db_names str
    Backup DB Names.
    backup_download_url str
    Backup Download URL.
    backup_end_time str
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_id str
    Backup Id.
    backup_intranet_download_url str
    Backup Intranet DownloadURL.
    backup_job_id str
    The backup task ID.
    backup_mode str
    Backup Mode. Valid values: Automated, Manual.
    backup_size int
    Backup Size in Bytes.
    backup_start_time str
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_type str
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the resource. Valid values: Success, Failed.
    backupDbNames String
    Backup DB Names.
    backupDownloadUrl String
    Backup Download URL.
    backupEndTime String
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupId String
    Backup Id.
    backupIntranetDownloadUrl String
    Backup Intranet DownloadURL.
    backupJobId String
    The backup task ID.
    backupMode String
    Backup Mode. Valid values: Automated, Manual.
    backupSize Number
    Backup Size in Bytes.
    backupStartTime String
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupType String
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource. Valid values: Success, Failed.

    Look up Existing Backup Resource

    Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_db_names: Optional[str] = None,
        backup_download_url: Optional[str] = None,
        backup_end_time: Optional[str] = None,
        backup_id: Optional[str] = None,
        backup_intranet_download_url: Optional[str] = None,
        backup_job_id: Optional[str] = None,
        backup_method: Optional[str] = None,
        backup_mode: Optional[str] = None,
        backup_retention_period: Optional[int] = None,
        backup_size: Optional[int] = None,
        backup_start_time: Optional[str] = None,
        backup_type: Optional[str] = None,
        db_instance_id: Optional[str] = None,
        status: Optional[str] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:mongodb:Backup    get:      id: ${id}
    import {
  to = alicloud_mongodb_backup.example
  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:
    BackupDbNames string
    Backup DB Names.
    BackupDownloadUrl string
    Backup Download URL.
    BackupEndTime string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupId string
    Backup Id.
    BackupIntranetDownloadUrl string
    Backup Intranet DownloadURL.
    BackupJobId string
    The backup task ID.
    BackupMethod string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    BackupMode string
    Backup Mode. Valid values: Automated, Manual.
    BackupRetentionPeriod int
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    BackupSize int
    Backup Size in Bytes.
    BackupStartTime string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupType string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    DbInstanceId string
    The ID of the MongoDB instance.
    Status string
    The status of the resource. Valid values: Success, Failed.
    BackupDbNames string
    Backup DB Names.
    BackupDownloadUrl string
    Backup Download URL.
    BackupEndTime string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupId string
    Backup Id.
    BackupIntranetDownloadUrl string
    Backup Intranet DownloadURL.
    BackupJobId string
    The backup task ID.
    BackupMethod string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    BackupMode string
    Backup Mode. Valid values: Automated, Manual.
    BackupRetentionPeriod int
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    BackupSize int
    Backup Size in Bytes.
    BackupStartTime string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    BackupType string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    DbInstanceId string
    The ID of the MongoDB instance.
    Status string
    The status of the resource. Valid values: Success, Failed.
    backup_db_names string
    Backup DB Names.
    backup_download_url string
    Backup Download URL.
    backup_end_time string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_id string
    Backup Id.
    backup_intranet_download_url string
    Backup Intranet DownloadURL.
    backup_job_id string
    The backup task ID.
    backup_method string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backup_mode string
    Backup Mode. Valid values: Automated, Manual.
    backup_retention_period number
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    backup_size number
    Backup Size in Bytes.
    backup_start_time string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_type string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    db_instance_id string
    The ID of the MongoDB instance.
    status string
    The status of the resource. Valid values: Success, Failed.
    backupDbNames String
    Backup DB Names.
    backupDownloadUrl String
    Backup Download URL.
    backupEndTime String
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupId String
    Backup Id.
    backupIntranetDownloadUrl String
    Backup Intranet DownloadURL.
    backupJobId String
    The backup task ID.
    backupMethod String
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backupMode String
    Backup Mode. Valid values: Automated, Manual.
    backupRetentionPeriod Integer
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    backupSize Integer
    Backup Size in Bytes.
    backupStartTime String
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupType String
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    dbInstanceId String
    The ID of the MongoDB instance.
    status String
    The status of the resource. Valid values: Success, Failed.
    backupDbNames string
    Backup DB Names.
    backupDownloadUrl string
    Backup Download URL.
    backupEndTime string
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupId string
    Backup Id.
    backupIntranetDownloadUrl string
    Backup Intranet DownloadURL.
    backupJobId string
    The backup task ID.
    backupMethod string
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backupMode string
    Backup Mode. Valid values: Automated, Manual.
    backupRetentionPeriod number
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    backupSize number
    Backup Size in Bytes.
    backupStartTime string
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupType string
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    dbInstanceId string
    The ID of the MongoDB instance.
    status string
    The status of the resource. Valid values: Success, Failed.
    backup_db_names str
    Backup DB Names.
    backup_download_url str
    Backup Download URL.
    backup_end_time str
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_id str
    Backup Id.
    backup_intranet_download_url str
    Backup Intranet DownloadURL.
    backup_job_id str
    The backup task ID.
    backup_method str
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backup_mode str
    Backup Mode. Valid values: Automated, Manual.
    backup_retention_period int
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    backup_size int
    Backup Size in Bytes.
    backup_start_time str
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backup_type str
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    db_instance_id str
    The ID of the MongoDB instance.
    status str
    The status of the resource. Valid values: Success, Failed.
    backupDbNames String
    Backup DB Names.
    backupDownloadUrl String
    Backup Download URL.
    backupEndTime String
    The end time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupId String
    Backup Id.
    backupIntranetDownloadUrl String
    Backup Intranet DownloadURL.
    backupJobId String
    The backup task ID.
    backupMethod String
    Backup Method. Valid values: Snapshot, Physical, Logical. Default value: Physical.
    backupMode String
    Backup Mode. Valid values: Automated, Manual.
    backupRetentionPeriod Number
    Backup retention days. Valid values: 7 - 730, -1 (Long-term retention). Not passing means consistent with the default backup policy.
    backupSize Number
    Backup Size in Bytes.
    backupStartTime String
    The start time of this backup, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC time).
    backupType String
    Backup Type. Valid values: FullBackup, IncrementalBackup.
    dbInstanceId String
    The ID of the MongoDB instance.
    status String
    The status of the resource. Valid values: Success, Failed.

    Import

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

    $ pulumi import alicloud:mongodb/backup:Backup example <db_instance_id>:<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 alicloud logo
    Viewing docs for Alibaba Cloud v3.108.0
    published on Thursday, Sep 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial