Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. MongodbInstanceBackupDownloadTask
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.MongodbInstanceBackupDownloadTask

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Create MongodbInstanceBackupDownloadTask Resource

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

    Constructor syntax

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

@overload
def MongodbInstanceBackupDownloadTask(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      backup_name: Optional[str] = None,
                                      backup_sets: Optional[Sequence[MongodbInstanceBackupDownloadTaskBackupSetArgs]] = None,
                                      instance_id: Optional[str] = None,
                                      mongodb_instance_backup_download_task_id: Optional[str] = None)
    func NewMongodbInstanceBackupDownloadTask(ctx *Context, name string, args MongodbInstanceBackupDownloadTaskArgs, opts ...ResourceOption) (*MongodbInstanceBackupDownloadTask, error)
    public MongodbInstanceBackupDownloadTask(string name, MongodbInstanceBackupDownloadTaskArgs args, CustomResourceOptions? opts = null)
    public MongodbInstanceBackupDownloadTask(String name, MongodbInstanceBackupDownloadTaskArgs args)
public MongodbInstanceBackupDownloadTask(String name, MongodbInstanceBackupDownloadTaskArgs args, CustomResourceOptions options)

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

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

    BackupName string
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    BackupSets List<MongodbInstanceBackupDownloadTaskBackupSet>
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    InstanceId string
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    MongodbInstanceBackupDownloadTaskId string
    BackupName string
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    BackupSets []MongodbInstanceBackupDownloadTaskBackupSetArgs
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    InstanceId string
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    MongodbInstanceBackupDownloadTaskId string
    backupName String
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backupSets List<MongodbInstanceBackupDownloadTaskBackupSet>
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instanceId String
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodbInstanceBackupDownloadTaskId String
    backupName string
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backupSets MongodbInstanceBackupDownloadTaskBackupSet[]
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instanceId string
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodbInstanceBackupDownloadTaskId string
    backup_name str
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backup_sets Sequence[MongodbInstanceBackupDownloadTaskBackupSetArgs]
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instance_id str
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodb_instance_backup_download_task_id str
    backupName String
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backupSets List<Property Map>
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instanceId String
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodbInstanceBackupDownloadTaskId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MongodbInstanceBackupDownloadTask 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 MongodbInstanceBackupDownloadTask Resource

    Get an existing MongodbInstanceBackupDownloadTask 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?: MongodbInstanceBackupDownloadTaskState, opts?: CustomResourceOptions): MongodbInstanceBackupDownloadTask
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_name: Optional[str] = None,
        backup_sets: Optional[Sequence[MongodbInstanceBackupDownloadTaskBackupSetArgs]] = None,
        instance_id: Optional[str] = None,
        mongodb_instance_backup_download_task_id: Optional[str] = None) -> MongodbInstanceBackupDownloadTask
    func GetMongodbInstanceBackupDownloadTask(ctx *Context, name string, id IDInput, state *MongodbInstanceBackupDownloadTaskState, opts ...ResourceOption) (*MongodbInstanceBackupDownloadTask, error)
    public static MongodbInstanceBackupDownloadTask Get(string name, Input<string> id, MongodbInstanceBackupDownloadTaskState? state, CustomResourceOptions? opts = null)
    public static MongodbInstanceBackupDownloadTask get(String name, Output<String> id, MongodbInstanceBackupDownloadTaskState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:MongodbInstanceBackupDownloadTask    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:
    BackupName string
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    BackupSets List<MongodbInstanceBackupDownloadTaskBackupSet>
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    InstanceId string
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    MongodbInstanceBackupDownloadTaskId string
    BackupName string
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    BackupSets []MongodbInstanceBackupDownloadTaskBackupSetArgs
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    InstanceId string
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    MongodbInstanceBackupDownloadTaskId string
    backupName String
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backupSets List<MongodbInstanceBackupDownloadTaskBackupSet>
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instanceId String
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodbInstanceBackupDownloadTaskId String
    backupName string
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backupSets MongodbInstanceBackupDownloadTaskBackupSet[]
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instanceId string
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodbInstanceBackupDownloadTaskId string
    backup_name str
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backup_sets Sequence[MongodbInstanceBackupDownloadTaskBackupSetArgs]
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instance_id str
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodb_instance_backup_download_task_id str
    backupName String
    The name of the backup file to be downloaded can be obtained through the DescribeDBBackups interface.
    backupSets List<Property Map>
    Specifies the node names of replica sets to download or a list of shard names for sharded clusters.For example, the replica set cmgo-p8vnipr5, example (fixed value): BackupSets.0=cmgo-p8vnipr5_0, the full amount of data can be downloaded.For example, the sharded cluster cmgo-p8vnipr5, for example: BackupSets.0=cmgo-p8vnipr5_0&amp;BackupSets.1=cmgo-p8vnipr5_1, that is, to download the data of shard 0 and 1. If the sharded cluster needs to be downloaded in full, please pass in the example. Full slice name.
    instanceId String
    Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page.
    mongodbInstanceBackupDownloadTaskId String

    Supporting Types

    MongodbInstanceBackupDownloadTaskBackupSet, MongodbInstanceBackupDownloadTaskBackupSetArgs

    ReplicaSetId string
    Replication Id.
    ReplicaSetId string
    Replication Id.
    replicaSetId String
    Replication Id.
    replicaSetId string
    Replication Id.
    replica_set_id str
    Replication Id.
    replicaSetId String
    Replication Id.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud