Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. getCloudBackupCollectionRestoreJobs
Viewing docs for MongoDB Atlas v4.15.0
published on Friday, Aug 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupCollectionRestoreJobs

mongodbatlas logo mongodbatlas logo
Viewing docs for MongoDB Atlas v4.15.0
published on Friday, Aug 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.getCloudBackupCollectionRestoreJobs describes all collection restore jobs for a cluster.

    To use this data source, the requesting Service Account or API Key must have the Backup Manager or Project Owner role.

    Example Usage

    The following example lists collection restore jobs on a cluster, then reads one job by jobId. When jobId is omitted, the example defaults to the last job from the plural data source.

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
import * as std from "@pulumi/std";

export = async () => {
    // Read back collection restore jobs on a cluster without creating a new job.
    const _this = await mongodbatlas.getCloudBackupCollectionRestoreJobs({
        projectId: projectId,
        clusterName: clusterName,
    });
    const jobs = std.coalesce({
        input: [
            _this.results,
            [],
        ],
    }).result;
    const jobId = std.coalesce({
        input: [
            jobIdConfig,
            jobs.length > 0 ? jobs[jobs.length - 1].jobId : null,
        ],
    }).result;
    const thisGetCloudBackupCollectionRestoreJob = await mongodbatlas.getCloudBackupCollectionRestoreJob({
        projectId: projectId,
        clusterName: clusterName,
        jobId: jobId,
    });
    return {
        restoreJobs: .map(j => ({
            jobId: j.jobId,
            state: j.state,
            createdAt: j.createdAt,
        })),
        jobId: jobId,
        jobState: thisGetCloudBackupCollectionRestoreJob.state,
    };
}

    import pulumi
import pulumi_mongodbatlas as mongodbatlas
import pulumi_std as std

# Read back collection restore jobs on a cluster without creating a new job.
this = mongodbatlas.get_cloud_backup_collection_restore_jobs(project_id=project_id,
    cluster_name=cluster_name)
jobs = std.coalesce(input=[
    this.results,
    [],
])["result"]
job_id = std.coalesce(input=[
    job_id_config,
    jobs[len(jobs) - 1]["jobId"] if len(jobs) > 0 else None,
])["result"]
pulumi.export("restoreJobs", [{
    "jobId": j["jobId"],
    "state": j["state"],
    "createdAt": j["createdAt"],
} for j in jobs])
pulumi.export("jobId", job_id)
this_get_cloud_backup_collection_restore_job = mongodbatlas.get_cloud_backup_collection_restore_job(project_id=project_id,
    cluster_name=cluster_name,
    job_id=job_id)
pulumi.export("jobState", this_get_cloud_backup_collection_restore_job.state)

    Example coming soon!

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    // Read back collection restore jobs on a cluster without creating a new job.
    var @this = Mongodbatlas.GetCloudBackupCollectionRestoreJobs.Invoke(new()
    {
        ProjectId = projectId,
        ClusterName = clusterName,
    });

    var jobs = Std.Coalesce.Invoke(new()
    {
        Input = new[]
        {
            @this.Apply(@this => @this.Apply(getCloudBackupCollectionRestoreJobsResult => getCloudBackupCollectionRestoreJobsResult.Results)),
            new[] {},
        },
    }).Result;

    var jobId = Std.Coalesce.Invoke(new()
    {
        Input = new[]
        {
            jobIdConfig,
            jobs.Length > 0 ? jobs[jobs.Length - 1].JobId : null,
        },
    }).Result;

    var thisGetCloudBackupCollectionRestoreJob = Mongodbatlas.GetCloudBackupCollectionRestoreJob.Invoke(new()
    {
        ProjectId = projectId,
        ClusterName = clusterName,
        JobId = jobId,
    });

    return new Dictionary<string, object?>
    {
        ["restoreJobs"] = .Select(j => 
        {
            return 
            {
                { "jobId", j.JobId },
                { "state", j.State },
                { "createdAt", j.CreatedAt },
            };
        }).ToList(),
        ["jobId"] = jobId,
        ["jobState"] = thisGetCloudBackupCollectionRestoreJob.Apply(getCloudBackupCollectionRestoreJobResult => getCloudBackupCollectionRestoreJobResult.State),
    };
});

    Example coming soon!

    Example coming soon!

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

data "mongodbatlas_getcloudbackupcollectionrestorejobs" "this" {
  project_id   = projectId
  cluster_name = clusterName
}
data "std_coalesce" "invoke_1" {
  input = [data.mongodbatlas_getcloudbackupcollectionrestorejobs.this.results, []]
}
data "std_coalesce" "invoke_2" {
  input = [jobIdConfig, length(local.jobs) > 0 ? local.jobs[length(local.jobs) - 1].job_id : null]
}
data "mongodbatlas_getcloudbackupcollectionrestorejob" "thisGetCloudBackupCollectionRestoreJob" {
  project_id   = projectId
  cluster_name = clusterName
  job_id       = local.jobId
}

# Read back collection restore jobs on a cluster without creating a new job.
locals {
  jobs = data.std_coalesce.invoke_1.result
}
locals {
  jobId = data.std_coalesce.invoke_2.result
}
output "restoreJobs" {
  value = [for j in local.jobs : {
    "jobId"     = j.jobId
    "state"     = j.state
    "createdAt" = j.createdAt
  } ]
}
output "jobId" {
  value = local.jobId
}
output "jobState" {
  value = data.mongodbatlas_getcloudbackupcollectionrestorejob.thisGetCloudBackupCollectionRestoreJob.state
}

    Further Examples

    • Restore job inspection
    • Snapshot restore
    • Point-in-time restore
    • Snapshot discovery

    Using getCloudBackupCollectionRestoreJobs

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudBackupCollectionRestoreJobs(args: GetCloudBackupCollectionRestoreJobsArgs, opts?: InvokeOptions): Promise<GetCloudBackupCollectionRestoreJobsResult>
function getCloudBackupCollectionRestoreJobsOutput(args: GetCloudBackupCollectionRestoreJobsOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudBackupCollectionRestoreJobsResult>
    def get_cloud_backup_collection_restore_jobs(cluster_name: Optional[str] = None,
                                             project_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetCloudBackupCollectionRestoreJobsResult
def get_cloud_backup_collection_restore_jobs_output(cluster_name: pulumi.Input[Optional[str]] = None,
                                             project_id: pulumi.Input[Optional[str]] = None,
                                             opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudBackupCollectionRestoreJobsResult]
    func LookupCloudBackupCollectionRestoreJobs(ctx *Context, args *LookupCloudBackupCollectionRestoreJobsArgs, opts ...InvokeOption) (*LookupCloudBackupCollectionRestoreJobsResult, error)
func LookupCloudBackupCollectionRestoreJobsOutput(ctx *Context, args *LookupCloudBackupCollectionRestoreJobsOutputArgs, opts ...InvokeOption) LookupCloudBackupCollectionRestoreJobsResultOutput

    > Note: This function is named LookupCloudBackupCollectionRestoreJobs in the Go SDK.

    public static class GetCloudBackupCollectionRestoreJobs 
{
    public static Task<GetCloudBackupCollectionRestoreJobsResult> InvokeAsync(GetCloudBackupCollectionRestoreJobsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupCollectionRestoreJobsResult> Invoke(GetCloudBackupCollectionRestoreJobsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupCollectionRestoreJobsResult> Invoke(GetCloudBackupCollectionRestoreJobsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudBackupCollectionRestoreJobsResult> getCloudBackupCollectionRestoreJobs(GetCloudBackupCollectionRestoreJobsArgs args, InvokeOptions options)
public static Output<GetCloudBackupCollectionRestoreJobsResult> getCloudBackupCollectionRestoreJobs(GetCloudBackupCollectionRestoreJobsArgs args, InvokeOptions options)
public static Output<GetCloudBackupCollectionRestoreJobsResult> getCloudBackupCollectionRestoreJobs(GetCloudBackupCollectionRestoreJobsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: mongodbatlas:index/getCloudBackupCollectionRestoreJobs:getCloudBackupCollectionRestoreJobs
  arguments:
    # arguments dictionary
    data "mongodbatlas_get_cloud_backup_collection_restore_jobs" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterName string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    ClusterName string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    cluster_name string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    clusterName String
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    clusterName string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    cluster_name str
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    clusterName String
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.

    getCloudBackupCollectionRestoreJobs Result

    The following output properties are available:

    ClusterName string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Results List<GetCloudBackupCollectionRestoreJobsResult>
    List of returned documents that MongoDB Cloud provides when completing this request.
    ClusterName string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Results []GetCloudBackupCollectionRestoreJobsResult
    List of returned documents that MongoDB Cloud provides when completing this request.
    cluster_name string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results list(object)
    List of returned documents that MongoDB Cloud provides when completing this request.
    clusterName String
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results List<GetCloudBackupCollectionRestoreJobsResult>
    List of returned documents that MongoDB Cloud provides when completing this request.
    clusterName string
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results GetCloudBackupCollectionRestoreJobsResult[]
    List of returned documents that MongoDB Cloud provides when completing this request.
    cluster_name str
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results Sequence[GetCloudBackupCollectionRestoreJobsResult]
    List of returned documents that MongoDB Cloud provides when completing this request.
    clusterName String
    Human-readable label that identifies the cluster with the collection restore jobs you want to return.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results List<Property Map>
    List of returned documents that MongoDB Cloud provides when completing this request.

    Supporting Types

    GetCloudBackupCollectionRestoreJobsResult

    CollectionSuffix string
    Suffix applied to restored collection names.
    Collections List<GetCloudBackupCollectionRestoreJobsResultCollection>
    List of collections in the restore scope (up to 100 items).
    CreatedAt string
    Date and time when the restore job was created (ISO 8601 format in UTC).
    DatabaseSuffix string
    Suffix applied to restored database names.
    Databases List<GetCloudBackupCollectionRestoreJobsResultDatabase>
    List of databases in the restore scope (up to 100 items).
    ErrorMessage string
    Error message when the job has failed or been canceled.
    FinishedAt string
    Date and time when the restore job finished (ISO 8601 format in UTC).
    IndexStatus GetCloudBackupCollectionRestoreJobsResultIndexStatus
    Overall index build status for a collection restore job.
    IndexStrategy string
    Strategy for restoring indexes (all, none, or all except TTL).
    JobId string
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    OplogInc int
    Oplog increment for point-in-time restore.
    OplogTs int
    Oplog timestamp (seconds part) for point-in-time restore.
    PointInTimeUtcSeconds int
    Point-in-time restore time in seconds since UNIX epoch.
    RestoredDocuments int
    Number of documents restored so far across all supported collections.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    State string
    Current state of the collection restore job.
    TargetClusterName string
    Human-readable label that identifies the target cluster.
    TargetProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    TotalDocuments int
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    WriteStrategy string
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
    CollectionSuffix string
    Suffix applied to restored collection names.
    Collections []GetCloudBackupCollectionRestoreJobsResultCollection
    List of collections in the restore scope (up to 100 items).
    CreatedAt string
    Date and time when the restore job was created (ISO 8601 format in UTC).
    DatabaseSuffix string
    Suffix applied to restored database names.
    Databases []GetCloudBackupCollectionRestoreJobsResultDatabase
    List of databases in the restore scope (up to 100 items).
    ErrorMessage string
    Error message when the job has failed or been canceled.
    FinishedAt string
    Date and time when the restore job finished (ISO 8601 format in UTC).
    IndexStatus GetCloudBackupCollectionRestoreJobsResultIndexStatus
    Overall index build status for a collection restore job.
    IndexStrategy string
    Strategy for restoring indexes (all, none, or all except TTL).
    JobId string
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    OplogInc int
    Oplog increment for point-in-time restore.
    OplogTs int
    Oplog timestamp (seconds part) for point-in-time restore.
    PointInTimeUtcSeconds int
    Point-in-time restore time in seconds since UNIX epoch.
    RestoredDocuments int
    Number of documents restored so far across all supported collections.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    State string
    Current state of the collection restore job.
    TargetClusterName string
    Human-readable label that identifies the target cluster.
    TargetProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    TotalDocuments int
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    WriteStrategy string
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
    collection_suffix string
    Suffix applied to restored collection names.
    collections list(object)
    List of collections in the restore scope (up to 100 items).
    created_at string
    Date and time when the restore job was created (ISO 8601 format in UTC).
    database_suffix string
    Suffix applied to restored database names.
    databases list(object)
    List of databases in the restore scope (up to 100 items).
    error_message string
    Error message when the job has failed or been canceled.
    finished_at string
    Date and time when the restore job finished (ISO 8601 format in UTC).
    index_status object
    Overall index build status for a collection restore job.
    index_strategy string
    Strategy for restoring indexes (all, none, or all except TTL).
    job_id string
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    oplog_inc number
    Oplog increment for point-in-time restore.
    oplog_ts number
    Oplog timestamp (seconds part) for point-in-time restore.
    point_in_time_utc_seconds number
    Point-in-time restore time in seconds since UNIX epoch.
    restored_documents number
    Number of documents restored so far across all supported collections.
    snapshot_id string
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    state string
    Current state of the collection restore job.
    target_cluster_name string
    Human-readable label that identifies the target cluster.
    target_project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    total_documents number
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    write_strategy string
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
    collectionSuffix String
    Suffix applied to restored collection names.
    collections List<GetCloudBackupCollectionRestoreJobsResultCollection>
    List of collections in the restore scope (up to 100 items).
    createdAt String
    Date and time when the restore job was created (ISO 8601 format in UTC).
    databaseSuffix String
    Suffix applied to restored database names.
    databases List<GetCloudBackupCollectionRestoreJobsResultDatabase>
    List of databases in the restore scope (up to 100 items).
    errorMessage String
    Error message when the job has failed or been canceled.
    finishedAt String
    Date and time when the restore job finished (ISO 8601 format in UTC).
    indexStatus GetCloudBackupCollectionRestoreJobsResultIndexStatus
    Overall index build status for a collection restore job.
    indexStrategy String
    Strategy for restoring indexes (all, none, or all except TTL).
    jobId String
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    oplogInc Integer
    Oplog increment for point-in-time restore.
    oplogTs Integer
    Oplog timestamp (seconds part) for point-in-time restore.
    pointInTimeUtcSeconds Integer
    Point-in-time restore time in seconds since UNIX epoch.
    restoredDocuments Integer
    Number of documents restored so far across all supported collections.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    state String
    Current state of the collection restore job.
    targetClusterName String
    Human-readable label that identifies the target cluster.
    targetProjectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    totalDocuments Integer
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    writeStrategy String
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
    collectionSuffix string
    Suffix applied to restored collection names.
    collections GetCloudBackupCollectionRestoreJobsResultCollection[]
    List of collections in the restore scope (up to 100 items).
    createdAt string
    Date and time when the restore job was created (ISO 8601 format in UTC).
    databaseSuffix string
    Suffix applied to restored database names.
    databases GetCloudBackupCollectionRestoreJobsResultDatabase[]
    List of databases in the restore scope (up to 100 items).
    errorMessage string
    Error message when the job has failed or been canceled.
    finishedAt string
    Date and time when the restore job finished (ISO 8601 format in UTC).
    indexStatus GetCloudBackupCollectionRestoreJobsResultIndexStatus
    Overall index build status for a collection restore job.
    indexStrategy string
    Strategy for restoring indexes (all, none, or all except TTL).
    jobId string
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    oplogInc number
    Oplog increment for point-in-time restore.
    oplogTs number
    Oplog timestamp (seconds part) for point-in-time restore.
    pointInTimeUtcSeconds number
    Point-in-time restore time in seconds since UNIX epoch.
    restoredDocuments number
    Number of documents restored so far across all supported collections.
    snapshotId string
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    state string
    Current state of the collection restore job.
    targetClusterName string
    Human-readable label that identifies the target cluster.
    targetProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    totalDocuments number
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    writeStrategy string
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
    collection_suffix str
    Suffix applied to restored collection names.
    collections Sequence[GetCloudBackupCollectionRestoreJobsResultCollection]
    List of collections in the restore scope (up to 100 items).
    created_at str
    Date and time when the restore job was created (ISO 8601 format in UTC).
    database_suffix str
    Suffix applied to restored database names.
    databases Sequence[GetCloudBackupCollectionRestoreJobsResultDatabase]
    List of databases in the restore scope (up to 100 items).
    error_message str
    Error message when the job has failed or been canceled.
    finished_at str
    Date and time when the restore job finished (ISO 8601 format in UTC).
    index_status GetCloudBackupCollectionRestoreJobsResultIndexStatus
    Overall index build status for a collection restore job.
    index_strategy str
    Strategy for restoring indexes (all, none, or all except TTL).
    job_id str
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    oplog_inc int
    Oplog increment for point-in-time restore.
    oplog_ts int
    Oplog timestamp (seconds part) for point-in-time restore.
    point_in_time_utc_seconds int
    Point-in-time restore time in seconds since UNIX epoch.
    restored_documents int
    Number of documents restored so far across all supported collections.
    snapshot_id str
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    state str
    Current state of the collection restore job.
    target_cluster_name str
    Human-readable label that identifies the target cluster.
    target_project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    total_documents int
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    write_strategy str
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
    collectionSuffix String
    Suffix applied to restored collection names.
    collections List<Property Map>
    List of collections in the restore scope (up to 100 items).
    createdAt String
    Date and time when the restore job was created (ISO 8601 format in UTC).
    databaseSuffix String
    Suffix applied to restored database names.
    databases List<Property Map>
    List of databases in the restore scope (up to 100 items).
    errorMessage String
    Error message when the job has failed or been canceled.
    finishedAt String
    Date and time when the restore job finished (ISO 8601 format in UTC).
    indexStatus Property Map
    Overall index build status for a collection restore job.
    indexStrategy String
    Strategy for restoring indexes (all, none, or all except TTL).
    jobId String
    Unique 24-hexadecimal digit string that identifies the collection restore job.
    oplogInc Number
    Oplog increment for point-in-time restore.
    oplogTs Number
    Oplog timestamp (seconds part) for point-in-time restore.
    pointInTimeUtcSeconds Number
    Point-in-time restore time in seconds since UNIX epoch.
    restoredDocuments Number
    Number of documents restored so far across all supported collections.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the snapshot being restored.
    state String
    Current state of the collection restore job.
    targetClusterName String
    Human-readable label that identifies the target cluster.
    targetProjectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    totalDocuments Number
    Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
    writeStrategy String
    Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.

    GetCloudBackupCollectionRestoreJobsResultCollection

    SourceNamespace string
    Collection requested to restore, as database.collection.
    TargetNamespace string
    Requested target collection as database.collection; if empty, source namespace is used.
    SourceNamespace string
    Collection requested to restore, as database.collection.
    TargetNamespace string
    Requested target collection as database.collection; if empty, source namespace is used.
    source_namespace string
    Collection requested to restore, as database.collection.
    target_namespace string
    Requested target collection as database.collection; if empty, source namespace is used.
    sourceNamespace String
    Collection requested to restore, as database.collection.
    targetNamespace String
    Requested target collection as database.collection; if empty, source namespace is used.
    sourceNamespace string
    Collection requested to restore, as database.collection.
    targetNamespace string
    Requested target collection as database.collection; if empty, source namespace is used.
    source_namespace str
    Collection requested to restore, as database.collection.
    target_namespace str
    Requested target collection as database.collection; if empty, source namespace is used.
    sourceNamespace String
    Collection requested to restore, as database.collection.
    targetNamespace String
    Requested target collection as database.collection; if empty, source namespace is used.

    GetCloudBackupCollectionRestoreJobsResultDatabase

    SourceNamespace string
    Database name requested to restore.
    TargetNamespace string
    Requested target database name; if empty, source database name is used.
    SourceNamespace string
    Database name requested to restore.
    TargetNamespace string
    Requested target database name; if empty, source database name is used.
    source_namespace string
    Database name requested to restore.
    target_namespace string
    Requested target database name; if empty, source database name is used.
    sourceNamespace String
    Database name requested to restore.
    targetNamespace String
    Requested target database name; if empty, source database name is used.
    sourceNamespace string
    Database name requested to restore.
    targetNamespace string
    Requested target database name; if empty, source database name is used.
    source_namespace str
    Database name requested to restore.
    target_namespace str
    Requested target database name; if empty, source database name is used.
    sourceNamespace String
    Database name requested to restore.
    targetNamespace String
    Requested target database name; if empty, source database name is used.

    GetCloudBackupCollectionRestoreJobsResultIndexStatus

    FailedCollectionCount int
    Number of collections that failed to build indexes.
    State string
    Index build state indicating the status of index creation during or after a restore operation.
    FailedCollectionCount int
    Number of collections that failed to build indexes.
    State string
    Index build state indicating the status of index creation during or after a restore operation.
    failed_collection_count number
    Number of collections that failed to build indexes.
    state string
    Index build state indicating the status of index creation during or after a restore operation.
    failedCollectionCount Integer
    Number of collections that failed to build indexes.
    state String
    Index build state indicating the status of index creation during or after a restore operation.
    failedCollectionCount number
    Number of collections that failed to build indexes.
    state string
    Index build state indicating the status of index creation during or after a restore operation.
    failed_collection_count int
    Number of collections that failed to build indexes.
    state str
    Index build state indicating the status of index creation during or after a restore operation.
    failedCollectionCount Number
    Number of collections that failed to build indexes.
    state String
    Index build state indicating the status of index creation during or after a restore operation.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.15.0
    published on Friday, Aug 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial