GetCloudProviderSnapshotRestoreJobs

mongodbatlas.getCloudProviderSnapshotRestoreJobs provides a Cloud Backup Snapshot Restore Jobs datasource. Gets all the cloud backup snapshot restore jobs for the specified cluster.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Example Usage

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var testCloudProviderSnapshot = new Mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot", new Mongodbatlas.CloudProviderSnapshotArgs
        {
            ClusterName = "MyCluster",
            Description = "MyDescription",
            ProjectId = "5cf5a45a9ccf6400e60981b6",
            RetentionInDays = 1,
        });
        var testCloudProviderSnapshotRestoreJob = new Mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", new Mongodbatlas.CloudProviderSnapshotRestoreJobArgs
        {
            ClusterName = "MyCluster",
            DeliveryType = new Mongodbatlas.Inputs.CloudProviderSnapshotRestoreJobDeliveryTypeArgs
            {
                Automated = true,
                Target_cluster_name = "MyCluster",
                Target_project_id = "5cf5a45a9ccf6400e60981b6",
            },
            ProjectId = "5cf5a45a9ccf6400e60981b6",
            SnapshotId = testCloudProviderSnapshot.Id,
        });
        var testCloudProviderSnapshotRestoreJobs = Output.Tuple(testCloudProviderSnapshotRestoreJob.ClusterName, testCloudProviderSnapshotRestoreJob.ProjectId).Apply(values =>
        {
            var clusterName = values.Item1;
            var projectId = values.Item2;
            return Mongodbatlas.GetCloudProviderSnapshotRestoreJobs.InvokeAsync(new Mongodbatlas.GetCloudProviderSnapshotRestoreJobsArgs
            {
                ClusterName = clusterName,
                ItemsPerPage = 5,
                PageNum = 1,
                ProjectId = projectId,
            });
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-mongodbatlas/sdk/go/mongodbatlas"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        testCloudProviderSnapshot, err := mongodbatlas.NewCloudProviderSnapshot(ctx, "testCloudProviderSnapshot", &mongodbatlas.CloudProviderSnapshotArgs{
            ClusterName:     pulumi.String("MyCluster"),
            Description:     pulumi.String("MyDescription"),
            ProjectId:       pulumi.String("5cf5a45a9ccf6400e60981b6"),
            RetentionInDays: pulumi.Int(1),
        })
        if err != nil {
            return err
        }
        testCloudProviderSnapshotRestoreJob, err := mongodbatlas.NewCloudProviderSnapshotRestoreJob(ctx, "testCloudProviderSnapshotRestoreJob", &mongodbatlas.CloudProviderSnapshotRestoreJobArgs{
            ClusterName: pulumi.String("MyCluster"),
            DeliveryType: &mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeArgs{
                Automated:           pulumi.Bool(true),
                Target_cluster_name: pulumi.String("MyCluster"),
                Target_project_id:   pulumi.String("5cf5a45a9ccf6400e60981b6"),
            },
            ProjectId:  pulumi.String("5cf5a45a9ccf6400e60981b6"),
            SnapshotId: testCloudProviderSnapshot.ID(),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    cluster_name="MyCluster",
    description="MyDescription",
    project_id="5cf5a45a9ccf6400e60981b6",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    cluster_name="MyCluster",
    delivery_type=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeArgs(
        automated=True,
        target_cluster_name="MyCluster",
        target_project_id="5cf5a45a9ccf6400e60981b6",
    ),
    project_id="5cf5a45a9ccf6400e60981b6",
    snapshot_id=test_cloud_provider_snapshot.id)
test_cloud_provider_snapshot_restore_jobs = pulumi.Output.all(test_cloud_provider_snapshot_restore_job.cluster_name, test_cloud_provider_snapshot_restore_job.project_id).apply(lambda cluster_name, project_id: mongodbatlas.get_cloud_provider_snapshot_restore_jobs(cluster_name=cluster_name,
    items_per_page=5,
    page_num=1,
    project_id=project_id))

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

const testCloudProviderSnapshot = new mongodbatlas.CloudProviderSnapshot("test", {
    clusterName: "MyCluster",
    description: "MyDescription",
    projectId: "5cf5a45a9ccf6400e60981b6",
    retentionInDays: 1,
});
const testCloudProviderSnapshotRestoreJob = new mongodbatlas.CloudProviderSnapshotRestoreJob("test", {
    clusterName: "MyCluster",
    deliveryType: {
        automated: true,
        target_cluster_name: "MyCluster",
        target_project_id: "5cf5a45a9ccf6400e60981b6",
    },
    projectId: "5cf5a45a9ccf6400e60981b6",
    snapshotId: testCloudProviderSnapshot.id,
});
const testCloudProviderSnapshotRestoreJobs = pulumi.all([testCloudProviderSnapshotRestoreJob.clusterName, testCloudProviderSnapshotRestoreJob.projectId]).apply(([clusterName, projectId]) => mongodbatlas.getCloudProviderSnapshotRestoreJobs({
    clusterName: clusterName,
    itemsPerPage: 5,
    pageNum: 1,
    projectId: projectId,
}, { async: true }));

Using GetCloudProviderSnapshotRestoreJobs

function getCloudProviderSnapshotRestoreJobs(args: GetCloudProviderSnapshotRestoreJobsArgs, opts?: InvokeOptions): Promise<GetCloudProviderSnapshotRestoreJobsResult>

def get_cloud_provider_snapshot_restore_jobs(cluster_name: Optional[str] = None, items_per_page: Optional[int] = None, page_num: Optional[int] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetCloudProviderSnapshotRestoreJobsResult

func GetCloudProviderSnapshotRestoreJobs(ctx *Context, args *GetCloudProviderSnapshotRestoreJobsArgs, opts ...InvokeOption) (*GetCloudProviderSnapshotRestoreJobsResult, error)

public static class GetCloudProviderSnapshotRestoreJobs {
    public static Task<GetCloudProviderSnapshotRestoreJobsResult> InvokeAsync(GetCloudProviderSnapshotRestoreJobsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterName string: The name of the Atlas cluster for which you want to retrieve restore jobs.
ProjectId string: The unique identifier of the project for the Atlas cluster.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

ClusterName string: The name of the Atlas cluster for which you want to retrieve restore jobs.
ProjectId string: The unique identifier of the project for the Atlas cluster.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

clusterName string: The name of the Atlas cluster for which you want to retrieve restore jobs.
projectId string: The unique identifier of the project for the Atlas cluster.
itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum number: The page to return. Defaults to 1.

cluster_name str: The name of the Atlas cluster for which you want to retrieve restore jobs.
project_id str: The unique identifier of the project for the Atlas cluster.
items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
page_num int: The page to return. Defaults to 1.

GetCloudProviderSnapshotRestoreJobs Result

The following output properties are available:

ClusterName string
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetCloudProviderSnapshotRestoreJobsResult>: Includes cloudProviderSnapshotRestoreJob object for each item detailed in the results array section.
TotalCount int
ItemsPerPage int
PageNum int

ClusterName string
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetCloudProviderSnapshotRestoreJobsResultType: Includes cloudProviderSnapshotRestoreJob object for each item detailed in the results array section.
TotalCount int
ItemsPerPage int
PageNum int

clusterName string
id string: The provider-assigned unique ID for this managed resource.
projectId string
results GetCloudProviderSnapshotRestoreJobsResult[]: Includes cloudProviderSnapshotRestoreJob object for each item detailed in the results array section.
totalCount number
itemsPerPage number
pageNum number

cluster_name str
id str: The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetCloudProviderSnapshotRestoreJobsResult]: Includes cloudProviderSnapshotRestoreJob object for each item detailed in the results array section.
total_count int
items_per_page int
page_num int

Supporting Types

GetCloudProviderSnapshotRestoreJobsResult

See the output API doc for this type.

Cancelled bool: Indicates whether the restore job was canceled.
CreatedAt string: UTC ISO 8601 formatted point in time when Atlas created the restore job.
DeliveryType string: Type of restore job to create. Possible values are: automated and download.
DeliveryUrls List<string>: One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
Expired bool: Indicates whether the restore job expired.
ExpiresAt string: UTC ISO 8601 formatted point in time when the restore job expires.
FinishedAt string: UTC ISO 8601 formatted point in time when the restore job completed.
Id string: The unique identifier of the restore job.
OplogInc int
OplogTs int
PointInTimeUtcSeconds int
SnapshotId string: Unique identifier of the source snapshot ID of the restore job.
TargetClusterName string: Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
TargetProjectId string
Timestamp string: Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

Cancelled bool: Indicates whether the restore job was canceled.
CreatedAt string: UTC ISO 8601 formatted point in time when Atlas created the restore job.
DeliveryType string: Type of restore job to create. Possible values are: automated and download.
DeliveryUrls []string: One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
Expired bool: Indicates whether the restore job expired.
ExpiresAt string: UTC ISO 8601 formatted point in time when the restore job expires.
FinishedAt string: UTC ISO 8601 formatted point in time when the restore job completed.
Id string: The unique identifier of the restore job.
OplogInc int
OplogTs int
PointInTimeUtcSeconds int
SnapshotId string: Unique identifier of the source snapshot ID of the restore job.
TargetClusterName string: Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
TargetProjectId string
Timestamp string: Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

cancelled boolean: Indicates whether the restore job was canceled.
createdAt string: UTC ISO 8601 formatted point in time when Atlas created the restore job.
deliveryType string: Type of restore job to create. Possible values are: automated and download.
deliveryUrls string[]: One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired boolean: Indicates whether the restore job expired.
expiresAt string: UTC ISO 8601 formatted point in time when the restore job expires.
finishedAt string: UTC ISO 8601 formatted point in time when the restore job completed.
id string: The unique identifier of the restore job.
oplogInc number
oplogTs number
pointInTimeUtcSeconds number
snapshotId string: Unique identifier of the source snapshot ID of the restore job.
targetClusterName string: Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
targetProjectId string
timestamp string: Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

cancelled bool: Indicates whether the restore job was canceled.
created_at str: UTC ISO 8601 formatted point in time when Atlas created the restore job.
delivery_type str: Type of restore job to create. Possible values are: automated and download.
delivery_urls Sequence[str]: One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired bool: Indicates whether the restore job expired.
expires_at str: UTC ISO 8601 formatted point in time when the restore job expires.
finished_at str: UTC ISO 8601 formatted point in time when the restore job completed.
id str: The unique identifier of the restore job.
oplog_inc int
oplog_ts int
point_in_time_utc_seconds int
snapshot_id str: Unique identifier of the source snapshot ID of the restore job.
target_cluster_name str: Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
target_project_id str
timestamp str: Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

Package Details

Repository: https://github.com/pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud