1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. MongodbInstanceBackupRule
tencentcloud 1.82.47 published on Friday, Dec 19, 2025 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.MongodbInstanceBackupRule

tencentcloud logo
tencentcloud 1.82.47 published on Friday, Dec 19, 2025 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create mongodb instance backup rule

    Example Usage

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

const example = new tencentcloud.MongodbInstanceBackupRule("example", {
    instanceId: "cmgo-rnht8d3d",
    backupMethod: 0,
    backupTime: 10,
    backupRetentionPeriod: 7,
    backupVersion: 1,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.MongodbInstanceBackupRule("example",
    instance_id="cmgo-rnht8d3d",
    backup_method=0,
    backup_time=10,
    backup_retention_period=7,
    backup_version=1)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewMongodbInstanceBackupRule(ctx, "example", &tencentcloud.MongodbInstanceBackupRuleArgs{
			InstanceId:            pulumi.String("cmgo-rnht8d3d"),
			BackupMethod:          pulumi.Float64(0),
			BackupTime:            pulumi.Float64(10),
			BackupRetentionPeriod: pulumi.Float64(7),
			BackupVersion:         pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.MongodbInstanceBackupRule("example", new()
    {
        InstanceId = "cmgo-rnht8d3d",
        BackupMethod = 0,
        BackupTime = 10,
        BackupRetentionPeriod = 7,
        BackupVersion = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.MongodbInstanceBackupRule;
import com.pulumi.tencentcloud.MongodbInstanceBackupRuleArgs;
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 MongodbInstanceBackupRule("example", MongodbInstanceBackupRuleArgs.builder()
            .instanceId("cmgo-rnht8d3d")
            .backupMethod(0.0)
            .backupTime(10.0)
            .backupRetentionPeriod(7.0)
            .backupVersion(1.0)
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:MongodbInstanceBackupRule
    properties:
      instanceId: cmgo-rnht8d3d
      backupMethod: 0
      backupTime: 10
      backupRetentionPeriod: 7
      backupVersion: 1

    Create MongodbInstanceBackupRule Resource

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

    Constructor syntax

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

@overload
def MongodbInstanceBackupRule(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              backup_method: Optional[float] = None,
                              instance_id: Optional[str] = None,
                              backup_time: Optional[float] = None,
                              backup_version: Optional[float] = None,
                              backup_retention_period: Optional[float] = None,
                              backup_frequency: Optional[float] = None,
                              active_weekdays: Optional[str] = None,
                              alarm_water_level: Optional[float] = None,
                              long_term_active_days: Optional[str] = None,
                              long_term_expired_days: Optional[float] = None,
                              long_term_unit: Optional[str] = None,
                              mongodb_instance_backup_rule_id: Optional[str] = None,
                              notify: Optional[bool] = None,
                              oplog_expired_days: Optional[float] = None)
    func NewMongodbInstanceBackupRule(ctx *Context, name string, args MongodbInstanceBackupRuleArgs, opts ...ResourceOption) (*MongodbInstanceBackupRule, error)
    public MongodbInstanceBackupRule(string name, MongodbInstanceBackupRuleArgs args, CustomResourceOptions? opts = null)
    public MongodbInstanceBackupRule(String name, MongodbInstanceBackupRuleArgs args)
public MongodbInstanceBackupRule(String name, MongodbInstanceBackupRuleArgs args, CustomResourceOptions options)

    type: tencentcloud:MongodbInstanceBackupRule
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 MongodbInstanceBackupRuleArgs
    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 MongodbInstanceBackupRuleArgs
    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 MongodbInstanceBackupRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongodbInstanceBackupRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongodbInstanceBackupRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    BackupMethod double
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    BackupTime double
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    InstanceId string
    Instance ID.
    ActiveWeekdays string
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    AlarmWaterLevel double
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    BackupFrequency double
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    BackupRetentionPeriod double
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    BackupVersion double
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    LongTermActiveDays string
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    LongTermExpiredDays double
    Long-term backup retention period. Value range [30, 1075].
    LongTermUnit string
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    MongodbInstanceBackupRuleId string
    ID of the resource.
    Notify bool
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    OplogExpiredDays double
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    BackupMethod float64
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    BackupTime float64
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    InstanceId string
    Instance ID.
    ActiveWeekdays string
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    AlarmWaterLevel float64
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    BackupFrequency float64
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    BackupRetentionPeriod float64
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    BackupVersion float64
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    LongTermActiveDays string
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    LongTermExpiredDays float64
    Long-term backup retention period. Value range [30, 1075].
    LongTermUnit string
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    MongodbInstanceBackupRuleId string
    ID of the resource.
    Notify bool
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    OplogExpiredDays float64
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    backupMethod Double
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backupTime Double
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    instanceId String
    Instance ID.
    activeWeekdays String
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarmWaterLevel Double
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backupFrequency Double
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backupRetentionPeriod Double
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backupVersion Double
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    longTermActiveDays String
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    longTermExpiredDays Double
    Long-term backup retention period. Value range [30, 1075].
    longTermUnit String
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodbInstanceBackupRuleId String
    ID of the resource.
    notify_ Boolean
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplogExpiredDays Double
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    backupMethod number
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backupTime number
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    instanceId string
    Instance ID.
    activeWeekdays string
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarmWaterLevel number
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backupFrequency number
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backupRetentionPeriod number
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backupVersion number
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    longTermActiveDays string
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    longTermExpiredDays number
    Long-term backup retention period. Value range [30, 1075].
    longTermUnit string
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodbInstanceBackupRuleId string
    ID of the resource.
    notify boolean
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplogExpiredDays number
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    backup_method float
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backup_time float
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    instance_id str
    Instance ID.
    active_weekdays str
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarm_water_level float
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backup_frequency float
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backup_retention_period float
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backup_version float
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    long_term_active_days str
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    long_term_expired_days float
    Long-term backup retention period. Value range [30, 1075].
    long_term_unit str
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodb_instance_backup_rule_id str
    ID of the resource.
    notify bool
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplog_expired_days float
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    backupMethod Number
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backupTime Number
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    instanceId String
    Instance ID.
    activeWeekdays String
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarmWaterLevel Number
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backupFrequency Number
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backupRetentionPeriod Number
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backupVersion Number
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    longTermActiveDays String
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    longTermExpiredDays Number
    Long-term backup retention period. Value range [30, 1075].
    longTermUnit String
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodbInstanceBackupRuleId String
    ID of the resource.
    notify Boolean
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplogExpiredDays Number
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MongodbInstanceBackupRule Resource

    Get an existing MongodbInstanceBackupRule 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?: MongodbInstanceBackupRuleState, opts?: CustomResourceOptions): MongodbInstanceBackupRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_weekdays: Optional[str] = None,
        alarm_water_level: Optional[float] = None,
        backup_frequency: Optional[float] = None,
        backup_method: Optional[float] = None,
        backup_retention_period: Optional[float] = None,
        backup_time: Optional[float] = None,
        backup_version: Optional[float] = None,
        instance_id: Optional[str] = None,
        long_term_active_days: Optional[str] = None,
        long_term_expired_days: Optional[float] = None,
        long_term_unit: Optional[str] = None,
        mongodb_instance_backup_rule_id: Optional[str] = None,
        notify: Optional[bool] = None,
        oplog_expired_days: Optional[float] = None) -> MongodbInstanceBackupRule
    func GetMongodbInstanceBackupRule(ctx *Context, name string, id IDInput, state *MongodbInstanceBackupRuleState, opts ...ResourceOption) (*MongodbInstanceBackupRule, error)
    public static MongodbInstanceBackupRule Get(string name, Input<string> id, MongodbInstanceBackupRuleState? state, CustomResourceOptions? opts = null)
    public static MongodbInstanceBackupRule get(String name, Output<String> id, MongodbInstanceBackupRuleState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:MongodbInstanceBackupRule    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:
    ActiveWeekdays string
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    AlarmWaterLevel double
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    BackupFrequency double
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    BackupMethod double
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    BackupRetentionPeriod double
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    BackupTime double
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    BackupVersion double
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    InstanceId string
    Instance ID.
    LongTermActiveDays string
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    LongTermExpiredDays double
    Long-term backup retention period. Value range [30, 1075].
    LongTermUnit string
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    MongodbInstanceBackupRuleId string
    ID of the resource.
    Notify bool
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    OplogExpiredDays double
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    ActiveWeekdays string
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    AlarmWaterLevel float64
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    BackupFrequency float64
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    BackupMethod float64
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    BackupRetentionPeriod float64
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    BackupTime float64
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    BackupVersion float64
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    InstanceId string
    Instance ID.
    LongTermActiveDays string
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    LongTermExpiredDays float64
    Long-term backup retention period. Value range [30, 1075].
    LongTermUnit string
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    MongodbInstanceBackupRuleId string
    ID of the resource.
    Notify bool
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    OplogExpiredDays float64
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    activeWeekdays String
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarmWaterLevel Double
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backupFrequency Double
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backupMethod Double
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backupRetentionPeriod Double
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backupTime Double
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    backupVersion Double
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    instanceId String
    Instance ID.
    longTermActiveDays String
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    longTermExpiredDays Double
    Long-term backup retention period. Value range [30, 1075].
    longTermUnit String
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodbInstanceBackupRuleId String
    ID of the resource.
    notify_ Boolean
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplogExpiredDays Double
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    activeWeekdays string
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarmWaterLevel number
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backupFrequency number
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backupMethod number
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backupRetentionPeriod number
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backupTime number
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    backupVersion number
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    instanceId string
    Instance ID.
    longTermActiveDays string
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    longTermExpiredDays number
    Long-term backup retention period. Value range [30, 1075].
    longTermUnit string
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodbInstanceBackupRuleId string
    ID of the resource.
    notify boolean
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplogExpiredDays number
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    active_weekdays str
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarm_water_level float
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backup_frequency float
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backup_method float
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backup_retention_period float
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backup_time float
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    backup_version float
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    instance_id str
    Instance ID.
    long_term_active_days str
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    long_term_expired_days float
    Long-term backup retention period. Value range [30, 1075].
    long_term_unit str
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodb_instance_backup_rule_id str
    ID of the resource.
    notify bool
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplog_expired_days float
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].
    activeWeekdays String
    Specify the specific dates for automatic backups to be performed each week. Format: Enter a number between 0 and 6 to represent Sunday through Saturday (e.g., 1 represents Monday). Separate multiple dates with commas (,). Example: Entering 1,3,5 means the system will perform backups on Mondays, Wednesdays, and Fridays every week. Default: If not set, the default is a full cycle (0,1,2,3,4,5,6), meaning backups will be performed daily.
    alarmWaterLevel Number
    Sets the alarm threshold for backup dataset storage space usage. Unit: %. Default value: 100. Value range: [50, 300].
    backupFrequency Number
    Specify the daily automatic backup frequency. 12: Back up twice a day, approximately 12 hours apart; 24: Back up once a day (default), approximately 24 hours apart.
    backupMethod Number
    Set automatic backup method. Valid values:

    • 0: Logical backup;
    • 1: Physical backup;
    • 3: Snapshot backup (supported only in cloud disk version).
    backupRetentionPeriod Number
    Specifies the retention period for backup data. Unit: days, default is 7 days. Value range: [7, 365].
    backupTime Number
    Set the start time for automatic backup. The value range is: [0,23]. For example, setting this parameter to 2 means that backup starts at 02:00.
    backupVersion Number
    Backup version. Old version backup is 0, advanced backup is 1. Set this value to 1 when enabling advanced backup.
    instanceId String
    Instance ID.
    longTermActiveDays String
    Specify the specific backup dates to be retained long-term. This setting only takes effect when LongTermUnit is set to weekly or monthly. Weekly Retention: Enter a number between 0 and 6 to represent Sunday through Saturday. Separate multiple dates with commas. Monthly Retention: Enter a number between 1 and 31 to represent specific dates within the month. Separate multiple dates with commas.
    longTermExpiredDays Number
    Long-term backup retention period. Value range [30, 1075].
    longTermUnit String
    Long-term retention period. Supports selecting specific dates for backups on a weekly or monthly basis (e.g., backup data for the 1st and 15th of each month) to retain for a longer period. Disabled (default): Long-term retention is disabled. Weekly retention: Specify weekly. Monthly retention: Specify monthly.
    mongodbInstanceBackupRuleId String
    ID of the resource.
    notify Boolean
    Set whether to send failure alerts when automatic backup errors occur.

    • true: Send.
    • false: Do not send.
    oplogExpiredDays Number
    Incremental backup retention period. Unit: days. Default value: 7 days. Value range: [7,365].

    Import

    mongodb instance backup rule can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/mongodbInstanceBackupRule:MongodbInstanceBackupRule example cmgo-rnht8d3d

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.47 published on Friday, Dec 19, 2025 by tencentcloudstack
    Schema (JSON)
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate