1. Packages
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. getFlexRestoreJob
Viewing docs for MongoDB Atlas v4.8.0
published on Thursday, Apr 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getFlexRestoreJob

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.8.0
published on Thursday, Apr 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.getFlexRestoreJob describes a flex restore job.

    Example Usage

    S

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

const restoreJob = mongodbatlas.getFlexRestoreJob({
    projectId: projectId,
    name: example_cluster.name,
    restoreJobId: restoreJobId,
});
const restoreJobs = mongodbatlas.getFlexRestoreJobs({
    projectId: projectId,
    name: example_cluster.name,
});
export const mongodbatlasFlexRestoreJob = restoreJob.then(restoreJob => restoreJob.name);
export const mongodbatlasFlexRestoreJobs = restoreJobs.then(restoreJobs => .map(restoreJob => (restoreJob.restoreJobId)));

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

restore_job = mongodbatlas.get_flex_restore_job(project_id=project_id,
    name=example_cluster["name"],
    restore_job_id=restore_job_id)
restore_jobs = mongodbatlas.get_flex_restore_jobs(project_id=project_id,
    name=example_cluster["name"])
pulumi.export("mongodbatlasFlexRestoreJob", restore_job.name)
pulumi.export("mongodbatlasFlexRestoreJobs", [restore_job.restore_job_id for restoreJob in restore_jobs.results])

    Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    var restoreJob = Mongodbatlas.Index.GetFlexRestoreJob.Invoke(new()
    {
        ProjectId = projectId,
        Name = example_cluster.Name,
        RestoreJobId = restoreJobId,
    });

    var restoreJobs = Mongodbatlas.Index.GetFlexRestoreJobs.Invoke(new()
    {
        ProjectId = projectId,
        Name = example_cluster.Name,
    });

    return new Dictionary<string, object?>
    {
        ["mongodbatlasFlexRestoreJob"] = restoreJob.Apply(getFlexRestoreJobResult => getFlexRestoreJobResult.Name),
        ["mongodbatlasFlexRestoreJobs"] = .Select(restoreJob => 
        {
            return restoreJob.Apply(getFlexRestoreJobResult => getFlexRestoreJobResult.RestoreJobId);
        }).ToList(),
    };
});

    Example coming soon!

    Example coming soon!

    Using getFlexRestoreJob

    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 getFlexRestoreJob(args: GetFlexRestoreJobArgs, opts?: InvokeOptions): Promise<GetFlexRestoreJobResult>
function getFlexRestoreJobOutput(args: GetFlexRestoreJobOutputArgs, opts?: InvokeOptions): Output<GetFlexRestoreJobResult>
    def get_flex_restore_job(name: Optional[str] = None,
                         project_id: Optional[str] = None,
                         restore_job_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetFlexRestoreJobResult
def get_flex_restore_job_output(name: pulumi.Input[Optional[str]] = None,
                         project_id: pulumi.Input[Optional[str]] = None,
                         restore_job_id: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetFlexRestoreJobResult]
    func GetFlexRestoreJob(ctx *Context, args *GetFlexRestoreJobArgs, opts ...InvokeOption) (*GetFlexRestoreJobResult, error)
func GetFlexRestoreJobOutput(ctx *Context, args *GetFlexRestoreJobOutputArgs, opts ...InvokeOption) GetFlexRestoreJobResultOutput

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

    public static class GetFlexRestoreJob 
{
    public static Task<GetFlexRestoreJobResult> InvokeAsync(GetFlexRestoreJobArgs args, InvokeOptions? opts = null)
    public static Output<GetFlexRestoreJobResult> Invoke(GetFlexRestoreJobInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFlexRestoreJobResult> getFlexRestoreJob(GetFlexRestoreJobArgs args, InvokeOptions options)
public static Output<GetFlexRestoreJobResult> getFlexRestoreJob(GetFlexRestoreJobArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getFlexRestoreJob:getFlexRestoreJob
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    RestoreJobId string
    Unique 24-hexadecimal digit string that identifies the restore job.
    Name string
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    RestoreJobId string
    Unique 24-hexadecimal digit string that identifies the restore job.
    name String
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restoreJobId String
    Unique 24-hexadecimal digit string that identifies the restore job.
    name string
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restoreJobId string
    Unique 24-hexadecimal digit string that identifies the restore job.
    name str
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restore_job_id str
    Unique 24-hexadecimal digit string that identifies the restore job.
    name String
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restoreJobId String
    Unique 24-hexadecimal digit string that identifies the restore job.

    getFlexRestoreJob Result

    The following output properties are available:

    DeliveryType string
    Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
    ExpirationDate string
    Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    RestoreFinishedDate string
    Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    RestoreJobId string
    Unique 24-hexadecimal digit string that identifies the restore job.
    RestoreScheduledDate string
    Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SnapshotFinishedDate string
    Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the snapshot to restore.
    SnapshotUrl string
    Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
    Status string
    Phase of the restore workflow for this job at the time this resource made this request.
    TargetDeploymentItemName string
    Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.
    TargetProjectId string
    Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.
    DeliveryType string
    Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
    ExpirationDate string
    Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    RestoreFinishedDate string
    Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    RestoreJobId string
    Unique 24-hexadecimal digit string that identifies the restore job.
    RestoreScheduledDate string
    Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SnapshotFinishedDate string
    Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the snapshot to restore.
    SnapshotUrl string
    Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
    Status string
    Phase of the restore workflow for this job at the time this resource made this request.
    TargetDeploymentItemName string
    Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.
    TargetProjectId string
    Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.
    deliveryType String
    Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
    expirationDate String
    Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restoreFinishedDate String
    Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    restoreJobId String
    Unique 24-hexadecimal digit string that identifies the restore job.
    restoreScheduledDate String
    Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshotFinishedDate String
    Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the snapshot to restore.
    snapshotUrl String
    Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
    status String
    Phase of the restore workflow for this job at the time this resource made this request.
    targetDeploymentItemName String
    Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.
    targetProjectId String
    Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.
    deliveryType string
    Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
    expirationDate string
    Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restoreFinishedDate string
    Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    restoreJobId string
    Unique 24-hexadecimal digit string that identifies the restore job.
    restoreScheduledDate string
    Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshotFinishedDate string
    Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshotId string
    Unique 24-hexadecimal digit string that identifies the snapshot to restore.
    snapshotUrl string
    Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
    status string
    Phase of the restore workflow for this job at the time this resource made this request.
    targetDeploymentItemName string
    Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.
    targetProjectId string
    Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.
    delivery_type str
    Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
    expiration_date str
    Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restore_finished_date str
    Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    restore_job_id str
    Unique 24-hexadecimal digit string that identifies the restore job.
    restore_scheduled_date str
    Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshot_finished_date str
    Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshot_id str
    Unique 24-hexadecimal digit string that identifies the snapshot to restore.
    snapshot_url str
    Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
    status str
    Phase of the restore workflow for this job at the time this resource made this request.
    target_deployment_item_name str
    Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.
    target_project_id str
    Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.
    deliveryType String
    Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
    expirationDate String
    Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Human-readable label that identifies the flex cluster whose snapshot you want to restore.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    restoreFinishedDate String
    Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    restoreJobId String
    Unique 24-hexadecimal digit string that identifies the restore job.
    restoreScheduledDate String
    Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshotFinishedDate String
    Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the snapshot to restore.
    snapshotUrl String
    Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
    status String
    Phase of the restore workflow for this job at the time this resource made this request.
    targetDeploymentItemName String
    Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.
    targetProjectId String
    Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.

    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
    Viewing docs for MongoDB Atlas v4.8.0
    published on Thursday, Apr 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Try Pulumi Cloud free. Your team will thank you.