1. Docs
  2. Reference
  3. API
  4. mongodbatlas
  5. GetCloudProviderSnapshotRestoreJob

GetCloudProviderSnapshotRestoreJob

mongodbatlas..CloudProviderSnapshotRestoreJob provides a Cloud Provider Snapshot Restore Job entry datasource. Gets all cloud provider snapshot restore jobs for the specified cluster.

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

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 testMongodbatlasCloudProviderSnapshotRestoreJob = new mongodbatlas.CloudProviderSnapshotRestoreJob("test", {
    clusterName: "MyCluster",
    deliveryType: {
        automated: true,
        target_cluster_name: "MyCluster",
        target_project_id: "5cf5a45a9ccf6400e60981b6",
    },
    projectId: "5cf5a45a9ccf6400e60981b6",
    snapshotId: testCloudProviderSnapshot.id,
});
const testCloudProviderSnapshotRestoreJob = pulumi.all([testMongodbatlasCloudProviderSnapshotRestoreJob.clusterName, testMongodbatlasCloudProviderSnapshotRestoreJob.id, testMongodbatlasCloudProviderSnapshotRestoreJob.projectId]).apply(([clusterName, id, projectId]) => mongodbatlas.getCloudProviderSnapshotRestoreJob({
    clusterName: clusterName,
    jobId: id,
    projectId: projectId,
}, { async: true }));

Using GetCloudProviderSnapshotRestoreJob

function getCloudProviderSnapshotRestoreJob(args: GetCloudProviderSnapshotRestoreJobArgs, opts?: InvokeOptions): Promise<GetCloudProviderSnapshotRestoreJobResult>
function  get_cloud_provider_snapshot_restore_job(cluster_name=None, job_id=None, project_id=None, opts=None)
func LookupCloudProviderSnapshotRestoreJob(ctx *Context, args *LookupCloudProviderSnapshotRestoreJobArgs, opts ...InvokeOption) (*LookupCloudProviderSnapshotRestoreJobResult, error)

Note: This function is named LookupCloudProviderSnapshotRestoreJob in the Go SDK.

public static class GetCloudProviderSnapshotRestoreJob {
    public static Task<GetCloudProviderSnapshotRestoreJobResult> InvokeAsync(GetCloudProviderSnapshotRestoreJobArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterName string

The name of the Atlas cluster for which you want to retrieve the restore job.

JobId string

The unique identifier of the restore job to retrieve.

ProjectId string

The unique identifier of the project for the Atlas cluster.

ClusterName string

The name of the Atlas cluster for which you want to retrieve the restore job.

JobId string

The unique identifier of the restore job to retrieve.

ProjectId string

The unique identifier of the project for the Atlas cluster.

clusterName string

The name of the Atlas cluster for which you want to retrieve the restore job.

jobId string

The unique identifier of the restore job to retrieve.

projectId string

The unique identifier of the project for the Atlas cluster.

cluster_name str

The name of the Atlas cluster for which you want to retrieve the restore job.

job_id str

The unique identifier of the restore job to retrieve.

project_id str

The unique identifier of the project for the Atlas cluster.

GetCloudProviderSnapshotRestoreJob Result

The following output properties are available:

Cancelled bool

Indicates whether the restore job was canceled.

ClusterName string
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 provider-assigned unique ID for this managed resource.

JobId string
ProjectId string
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.

ClusterName string
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 provider-assigned unique ID for this managed resource.

JobId string
ProjectId string
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.

clusterName string
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 provider-assigned unique ID for this managed resource.

jobId string
projectId string
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.

cluster_name str
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 List[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 provider-assigned unique ID for this managed resource.

job_id str
project_id str
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.