mongodbatlas.getFlexRestoreJob

MongoDB Atlas v4.5.0, Mar 12 26

Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

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.GetFlexRestoreJob.Invoke(new()
    {
        ProjectId = projectId,
        Name = example_cluster.Name,
        RestoreJobId = restoreJobId,
    });

    var restoreJobs = Mongodbatlas.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: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         restore_job_id: Optional[pulumi.Input[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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
RestoreJobId string

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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
RestoreJobId string

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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restoreJobId String

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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restoreJobId string

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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restore_job_id str

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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restoreJobId String

getFlexRestoreJob Result

The following output properties are available:

DeliveryType string
ExpirationDate string
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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
RestoreFinishedDate string
RestoreJobId string
RestoreScheduledDate string
SnapshotFinishedDate string
SnapshotId string
SnapshotUrl string
Status string
TargetDeploymentItemName string
TargetProjectId string

DeliveryType string
ExpirationDate string
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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
RestoreFinishedDate string
RestoreJobId string
RestoreScheduledDate string
SnapshotFinishedDate string
SnapshotId string
SnapshotUrl string
Status string
TargetDeploymentItemName string
TargetProjectId string

deliveryType String
expirationDate String
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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restoreFinishedDate String
restoreJobId String
restoreScheduledDate String
snapshotFinishedDate String
snapshotId String
snapshotUrl String
status String
targetDeploymentItemName String
targetProjectId String

deliveryType string
expirationDate string
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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restoreFinishedDate string
restoreJobId string
restoreScheduledDate string
snapshotFinishedDate string
snapshotId string
snapshotUrl string
status string
targetDeploymentItemName string
targetProjectId string

delivery_type str
expiration_date str
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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restore_finished_date str
restore_job_id str
restore_scheduled_date str
snapshot_finished_date str
snapshot_id str
snapshot_url str
status str
target_deployment_item_name str
target_project_id str

deliveryType String
expirationDate String
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. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
restoreFinishedDate String
restoreJobId String
restoreScheduledDate String
snapshotFinishedDate String
snapshotId String
snapshotUrl String
status String
targetDeploymentItemName String
targetProjectId String