1. Pulumi Registry
  2. MongoDB Atlas
  3. API Docs
  4. CloudProviderSnapshotRestoreJob
mongodbatlas logo
MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.CloudProviderSnapshotRestoreJob

WARNING: This resource is deprecated, use mongodbatlas.CloudBackupSnapshotRestoreJob

mongodbatlas.CloudProviderSnapshotRestoreJob provides a resource to create a new restore job from a cloud backup snapshot of a specified cluster. The restore job can be one of three types:

  • automated: Atlas automatically restores the snapshot with snapshotId to the Atlas cluster with name targetClusterName in the Atlas project with targetGroupId.

  • download: Atlas provides a URL to download a .tar.gz of the snapshot with snapshotId. The contents of the archive contain the data files for your Atlas cluster.

  • pointInTime: Atlas performs a Continuous Cloud Backup restore.

Important: If you specify deliveryType : automated or deliveryType : pointInTime in your request body to create an automated restore job, Atlas removes all existing data on the target cluster prior to the restore.

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

Example Usage

Example automated delivery type.

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

return await Deployment.RunAsync(() => 
{
    var myCluster = new Mongodbatlas.Cluster("myCluster", new()
    {
        ProjectId = "5cf5a45a9ccf6400e60981b6",
        DiskSizeGb = 5,
        ProviderName = "AWS",
        ProviderRegionName = "EU_WEST_2",
        ProviderInstanceSizeName = "M10",
        CloudBackup = true,
    });

    // enable cloud backup snapshots
    var testCloudProviderSnapshot = new Mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot", new()
    {
        ProjectId = myCluster.ProjectId,
        ClusterName = myCluster.Name,
        Description = "myDescription",
        RetentionInDays = 1,
    });

    var testCloudProviderSnapshotRestoreJob = new Mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", new()
    {
        ProjectId = testCloudProviderSnapshot.ProjectId,
        ClusterName = testCloudProviderSnapshot.ClusterName,
        SnapshotId = testCloudProviderSnapshot.SnapshotId,
        DeliveryTypeConfig = new Mongodbatlas.Inputs.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs
        {
            Automated = true,
            TargetClusterName = "MyCluster",
            TargetProjectId = "5cf5a45a9ccf6400e60981b6",
        },
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            testCloudProviderSnapshot,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myCluster, err := mongodbatlas.NewCluster(ctx, "myCluster", &mongodbatlas.ClusterArgs{
			ProjectId:                pulumi.String("5cf5a45a9ccf6400e60981b6"),
			DiskSizeGb:               pulumi.Float64(5),
			ProviderName:             pulumi.String("AWS"),
			ProviderRegionName:       pulumi.String("EU_WEST_2"),
			ProviderInstanceSizeName: pulumi.String("M10"),
			CloudBackup:              pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		testCloudProviderSnapshot, err := mongodbatlas.NewCloudProviderSnapshot(ctx, "testCloudProviderSnapshot", &mongodbatlas.CloudProviderSnapshotArgs{
			ProjectId:       myCluster.ProjectId,
			ClusterName:     myCluster.Name,
			Description:     pulumi.String("myDescription"),
			RetentionInDays: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewCloudProviderSnapshotRestoreJob(ctx, "testCloudProviderSnapshotRestoreJob", &mongodbatlas.CloudProviderSnapshotRestoreJobArgs{
			ProjectId:   testCloudProviderSnapshot.ProjectId,
			ClusterName: testCloudProviderSnapshot.ClusterName,
			SnapshotId:  testCloudProviderSnapshot.SnapshotId,
			DeliveryTypeConfig: &mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs{
				Automated:         pulumi.Bool(true),
				TargetClusterName: pulumi.String("MyCluster"),
				TargetProjectId:   pulumi.String("5cf5a45a9ccf6400e60981b6"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			testCloudProviderSnapshot,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Cluster;
import com.pulumi.mongodbatlas.ClusterArgs;
import com.pulumi.mongodbatlas.CloudProviderSnapshot;
import com.pulumi.mongodbatlas.CloudProviderSnapshotArgs;
import com.pulumi.mongodbatlas.CloudProviderSnapshotRestoreJob;
import com.pulumi.mongodbatlas.CloudProviderSnapshotRestoreJobArgs;
import com.pulumi.mongodbatlas.inputs.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myCluster = new Cluster("myCluster", ClusterArgs.builder()        
            .projectId("5cf5a45a9ccf6400e60981b6")
            .diskSizeGb(5)
            .providerName("AWS")
            .providerRegionName("EU_WEST_2")
            .providerInstanceSizeName("M10")
            .cloudBackup(true)
            .build());

        var testCloudProviderSnapshot = new CloudProviderSnapshot("testCloudProviderSnapshot", CloudProviderSnapshotArgs.builder()        
            .projectId(myCluster.projectId())
            .clusterName(myCluster.name())
            .description("myDescription")
            .retentionInDays(1)
            .build());

        var testCloudProviderSnapshotRestoreJob = new CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", CloudProviderSnapshotRestoreJobArgs.builder()        
            .projectId(testCloudProviderSnapshot.projectId())
            .clusterName(testCloudProviderSnapshot.clusterName())
            .snapshotId(testCloudProviderSnapshot.snapshotId())
            .deliveryTypeConfig(CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
                .automated(true)
                .targetClusterName("MyCluster")
                .targetProjectId("5cf5a45a9ccf6400e60981b6")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(testCloudProviderSnapshot)
                .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.Cluster("myCluster",
    project_id="5cf5a45a9ccf6400e60981b6",
    disk_size_gb=5,
    provider_name="AWS",
    provider_region_name="EU_WEST_2",
    provider_instance_size_name="M10",
    cloud_backup=True)
# enable cloud backup snapshots
test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description="myDescription",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    project_id=test_cloud_provider_snapshot.project_id,
    cluster_name=test_cloud_provider_snapshot.cluster_name,
    snapshot_id=test_cloud_provider_snapshot.snapshot_id,
    delivery_type_config=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs(
        automated=True,
        target_cluster_name="MyCluster",
        target_project_id="5cf5a45a9ccf6400e60981b6",
    ),
    opts=pulumi.ResourceOptions(depends_on=[test_cloud_provider_snapshot]))

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

const myCluster = new mongodbatlas.Cluster("myCluster", {
    projectId: "5cf5a45a9ccf6400e60981b6",
    diskSizeGb: 5,
    providerName: "AWS",
    providerRegionName: "EU_WEST_2",
    providerInstanceSizeName: "M10",
    cloudBackup: true,
});
// enable cloud backup snapshots
const testCloudProviderSnapshot = new mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot", {
    projectId: myCluster.projectId,
    clusterName: myCluster.name,
    description: "myDescription",
    retentionInDays: 1,
});
const testCloudProviderSnapshotRestoreJob = new mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", {
    projectId: testCloudProviderSnapshot.projectId,
    clusterName: testCloudProviderSnapshot.clusterName,
    snapshotId: testCloudProviderSnapshot.snapshotId,
    deliveryTypeConfig: {
        automated: true,
        targetClusterName: "MyCluster",
        targetProjectId: "5cf5a45a9ccf6400e60981b6",
    },
}, {
    dependsOn: [testCloudProviderSnapshot],
});

resources:
  myCluster:
    type: mongodbatlas:Cluster
    properties:
      projectId: 5cf5a45a9ccf6400e60981b6
      diskSizeGb: 5
      # Provider Settings "block"
      providerName: AWS
      providerRegionName: EU_WEST_2
      providerInstanceSizeName: M10
      cloudBackup: true
  testCloudProviderSnapshot:
    type: mongodbatlas:CloudProviderSnapshot
    properties:
      projectId: ${myCluster.projectId}
      clusterName: ${myCluster.name}
      description: myDescription
      retentionInDays: 1
  testCloudProviderSnapshotRestoreJob:
    type: mongodbatlas:CloudProviderSnapshotRestoreJob
    properties:
      projectId: ${testCloudProviderSnapshot.projectId}
      clusterName: ${testCloudProviderSnapshot.clusterName}
      snapshotId: ${testCloudProviderSnapshot.snapshotId}
      deliveryTypeConfig:
        automated: true
        targetClusterName: MyCluster
        targetProjectId: 5cf5a45a9ccf6400e60981b6
    options:
      dependson:
        - ${testCloudProviderSnapshot}

Example download delivery type.

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

return await Deployment.RunAsync(() => 
{
    var myCluster = new Mongodbatlas.Cluster("myCluster", new()
    {
        ProjectId = "5cf5a45a9ccf6400e60981b6",
        DiskSizeGb = 5,
        ProviderName = "AWS",
        ProviderRegionName = "EU_WEST_2",
        ProviderInstanceSizeName = "M10",
        CloudBackup = true,
    });

    // enable cloud backup snapshots
    var testCloudProviderSnapshot = new Mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot", new()
    {
        ProjectId = myCluster.ProjectId,
        ClusterName = myCluster.Name,
        Description = "myDescription",
        RetentionInDays = 1,
    });

    var testCloudProviderSnapshotRestoreJob = new Mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", new()
    {
        ProjectId = testCloudProviderSnapshot.ProjectId,
        ClusterName = testCloudProviderSnapshot.ClusterName,
        SnapshotId = testCloudProviderSnapshot.SnapshotId,
        DeliveryTypeConfig = new Mongodbatlas.Inputs.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs
        {
            Download = true,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myCluster, err := mongodbatlas.NewCluster(ctx, "myCluster", &mongodbatlas.ClusterArgs{
			ProjectId:                pulumi.String("5cf5a45a9ccf6400e60981b6"),
			DiskSizeGb:               pulumi.Float64(5),
			ProviderName:             pulumi.String("AWS"),
			ProviderRegionName:       pulumi.String("EU_WEST_2"),
			ProviderInstanceSizeName: pulumi.String("M10"),
			CloudBackup:              pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		testCloudProviderSnapshot, err := mongodbatlas.NewCloudProviderSnapshot(ctx, "testCloudProviderSnapshot", &mongodbatlas.CloudProviderSnapshotArgs{
			ProjectId:       myCluster.ProjectId,
			ClusterName:     myCluster.Name,
			Description:     pulumi.String("myDescription"),
			RetentionInDays: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewCloudProviderSnapshotRestoreJob(ctx, "testCloudProviderSnapshotRestoreJob", &mongodbatlas.CloudProviderSnapshotRestoreJobArgs{
			ProjectId:   testCloudProviderSnapshot.ProjectId,
			ClusterName: testCloudProviderSnapshot.ClusterName,
			SnapshotId:  testCloudProviderSnapshot.SnapshotId,
			DeliveryTypeConfig: &mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs{
				Download: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Cluster;
import com.pulumi.mongodbatlas.ClusterArgs;
import com.pulumi.mongodbatlas.CloudProviderSnapshot;
import com.pulumi.mongodbatlas.CloudProviderSnapshotArgs;
import com.pulumi.mongodbatlas.CloudProviderSnapshotRestoreJob;
import com.pulumi.mongodbatlas.CloudProviderSnapshotRestoreJobArgs;
import com.pulumi.mongodbatlas.inputs.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myCluster = new Cluster("myCluster", ClusterArgs.builder()        
            .projectId("5cf5a45a9ccf6400e60981b6")
            .diskSizeGb(5)
            .providerName("AWS")
            .providerRegionName("EU_WEST_2")
            .providerInstanceSizeName("M10")
            .cloudBackup(true)
            .build());

        var testCloudProviderSnapshot = new CloudProviderSnapshot("testCloudProviderSnapshot", CloudProviderSnapshotArgs.builder()        
            .projectId(myCluster.projectId())
            .clusterName(myCluster.name())
            .description("myDescription")
            .retentionInDays(1)
            .build());

        var testCloudProviderSnapshotRestoreJob = new CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", CloudProviderSnapshotRestoreJobArgs.builder()        
            .projectId(testCloudProviderSnapshot.projectId())
            .clusterName(testCloudProviderSnapshot.clusterName())
            .snapshotId(testCloudProviderSnapshot.snapshotId())
            .deliveryTypeConfig(CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
                .download(true)
                .build())
            .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.Cluster("myCluster",
    project_id="5cf5a45a9ccf6400e60981b6",
    disk_size_gb=5,
    provider_name="AWS",
    provider_region_name="EU_WEST_2",
    provider_instance_size_name="M10",
    cloud_backup=True)
# enable cloud backup snapshots
test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description="myDescription",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    project_id=test_cloud_provider_snapshot.project_id,
    cluster_name=test_cloud_provider_snapshot.cluster_name,
    snapshot_id=test_cloud_provider_snapshot.snapshot_id,
    delivery_type_config=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs(
        download=True,
    ))

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

const myCluster = new mongodbatlas.Cluster("myCluster", {
    projectId: "5cf5a45a9ccf6400e60981b6",
    diskSizeGb: 5,
    providerName: "AWS",
    providerRegionName: "EU_WEST_2",
    providerInstanceSizeName: "M10",
    cloudBackup: true,
});
// enable cloud backup snapshots
const testCloudProviderSnapshot = new mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot", {
    projectId: myCluster.projectId,
    clusterName: myCluster.name,
    description: "myDescription",
    retentionInDays: 1,
});
const testCloudProviderSnapshotRestoreJob = new mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob", {
    projectId: testCloudProviderSnapshot.projectId,
    clusterName: testCloudProviderSnapshot.clusterName,
    snapshotId: testCloudProviderSnapshot.snapshotId,
    deliveryTypeConfig: {
        download: true,
    },
});

resources:
  myCluster:
    type: mongodbatlas:Cluster
    properties:
      projectId: 5cf5a45a9ccf6400e60981b6
      diskSizeGb: 5
      # Provider Settings "block"
      providerName: AWS
      providerRegionName: EU_WEST_2
      providerInstanceSizeName: M10
      cloudBackup: true
  testCloudProviderSnapshot:
    type: mongodbatlas:CloudProviderSnapshot
    properties:
      projectId: ${myCluster.projectId}
      clusterName: ${myCluster.name}
      description: myDescription
      retentionInDays: 1
  testCloudProviderSnapshotRestoreJob:
    type: mongodbatlas:CloudProviderSnapshotRestoreJob
    properties:
      projectId: ${testCloudProviderSnapshot.projectId}
      clusterName: ${testCloudProviderSnapshot.clusterName}
      snapshotId: ${testCloudProviderSnapshot.snapshotId}
      deliveryTypeConfig:
        download: true

Create CloudProviderSnapshotRestoreJob Resource

new CloudProviderSnapshotRestoreJob(name: string, args: CloudProviderSnapshotRestoreJobArgs, opts?: CustomResourceOptions);
@overload
def CloudProviderSnapshotRestoreJob(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    cluster_name: Optional[str] = None,
                                    delivery_type: Optional[Mapping[str, str]] = None,
                                    delivery_type_config: Optional[CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs] = None,
                                    project_id: Optional[str] = None,
                                    snapshot_id: Optional[str] = None)
@overload
def CloudProviderSnapshotRestoreJob(resource_name: str,
                                    args: CloudProviderSnapshotRestoreJobArgs,
                                    opts: Optional[ResourceOptions] = None)
func NewCloudProviderSnapshotRestoreJob(ctx *Context, name string, args CloudProviderSnapshotRestoreJobArgs, opts ...ResourceOption) (*CloudProviderSnapshotRestoreJob, error)
public CloudProviderSnapshotRestoreJob(string name, CloudProviderSnapshotRestoreJobArgs args, CustomResourceOptions? opts = null)
public CloudProviderSnapshotRestoreJob(String name, CloudProviderSnapshotRestoreJobArgs args)
public CloudProviderSnapshotRestoreJob(String name, CloudProviderSnapshotRestoreJobArgs args, CustomResourceOptions options)

type: mongodbatlas:CloudProviderSnapshotRestoreJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CloudProviderSnapshotRestoreJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CloudProviderSnapshotRestoreJobArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CloudProviderSnapshotRestoreJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CloudProviderSnapshotRestoreJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CloudProviderSnapshotRestoreJobArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CloudProviderSnapshotRestoreJob Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CloudProviderSnapshotRestoreJob resource accepts the following input properties:

ClusterName string

The name of the Atlas cluster whose snapshot you want to restore.

ProjectId string

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

SnapshotId string

Unique identifier of the snapshot to restore.

DeliveryType Dictionary<string, string>

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

DeliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

Type of restore job to create. Possible values are: automated and download.

ClusterName string

The name of the Atlas cluster whose snapshot you want to restore.

ProjectId string

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

SnapshotId string

Unique identifier of the snapshot to restore.

DeliveryType map[string]string

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

DeliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

Type of restore job to create. Possible values are: automated and download.

clusterName String

The name of the Atlas cluster whose snapshot you want to restore.

projectId String

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshotId String

Unique identifier of the snapshot to restore.

deliveryType Map<String,String>

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

deliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

Type of restore job to create. Possible values are: automated and download.

clusterName string

The name of the Atlas cluster whose snapshot you want to restore.

projectId string

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshotId string

Unique identifier of the snapshot to restore.

deliveryType {[key: string]: string}

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

deliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

Type of restore job to create. Possible values are: automated and download.

cluster_name str

The name of the Atlas cluster whose snapshot you want to restore.

project_id str

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshot_id str

Unique identifier of the snapshot to restore.

delivery_type Mapping[str, str]

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

delivery_type_config CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

Type of restore job to create. Possible values are: automated and download.

clusterName String

The name of the Atlas cluster whose snapshot you want to restore.

projectId String

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshotId String

Unique identifier of the snapshot to restore.

deliveryType Map<String>

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

deliveryTypeConfig Property Map

Type of restore job to create. Possible values are: automated and download.

Outputs

All input properties are implicitly available as output properties. Additionally, the CloudProviderSnapshotRestoreJob resource produces the following output properties:

Cancelled bool

Indicates whether the restore job was canceled.

CreatedAt string

UTC ISO 8601 formatted point in time when Atlas created the restore job.

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.

SnapshotRestoreJobId string

The unique identifier of the restore job.

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.

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.

SnapshotRestoreJobId string

The unique identifier of the restore job.

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.

deliveryUrls List<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.

snapshotRestoreJobId String

The unique identifier of the restore job.

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.

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.

snapshotRestoreJobId string

The unique identifier of the restore job.

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

snapshot_restore_job_id str

The unique identifier of the restore job.

timestamp str

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.

deliveryUrls List<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.

snapshotRestoreJobId String

The unique identifier of the restore job.

timestamp String

Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

Look up Existing CloudProviderSnapshotRestoreJob Resource

Get an existing CloudProviderSnapshotRestoreJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CloudProviderSnapshotRestoreJobState, opts?: CustomResourceOptions): CloudProviderSnapshotRestoreJob
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cancelled: Optional[bool] = None,
        cluster_name: Optional[str] = None,
        created_at: Optional[str] = None,
        delivery_type: Optional[Mapping[str, str]] = None,
        delivery_type_config: Optional[CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs] = None,
        delivery_urls: Optional[Sequence[str]] = None,
        expired: Optional[bool] = None,
        expires_at: Optional[str] = None,
        finished_at: Optional[str] = None,
        project_id: Optional[str] = None,
        snapshot_id: Optional[str] = None,
        snapshot_restore_job_id: Optional[str] = None,
        timestamp: Optional[str] = None) -> CloudProviderSnapshotRestoreJob
func GetCloudProviderSnapshotRestoreJob(ctx *Context, name string, id IDInput, state *CloudProviderSnapshotRestoreJobState, opts ...ResourceOption) (*CloudProviderSnapshotRestoreJob, error)
public static CloudProviderSnapshotRestoreJob Get(string name, Input<string> id, CloudProviderSnapshotRestoreJobState? state, CustomResourceOptions? opts = null)
public static CloudProviderSnapshotRestoreJob get(String name, Output<String> id, CloudProviderSnapshotRestoreJobState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Cancelled bool

Indicates whether the restore job was canceled.

ClusterName string

The name of the Atlas cluster whose snapshot you want to restore.

CreatedAt string

UTC ISO 8601 formatted point in time when Atlas created the restore job.

DeliveryType Dictionary<string, string>

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

DeliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

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.

ProjectId string

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

SnapshotId string

Unique identifier of the snapshot to restore.

SnapshotRestoreJobId string

The unique identifier of the restore job.

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

The name of the Atlas cluster whose snapshot you want to restore.

CreatedAt string

UTC ISO 8601 formatted point in time when Atlas created the restore job.

DeliveryType map[string]string

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

DeliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

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.

ProjectId string

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

SnapshotId string

Unique identifier of the snapshot to restore.

SnapshotRestoreJobId string

The unique identifier of the restore job.

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

The name of the Atlas cluster whose snapshot you want to restore.

createdAt String

UTC ISO 8601 formatted point in time when Atlas created the restore job.

deliveryType Map<String,String>

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

deliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

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 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.

projectId String

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshotId String

Unique identifier of the snapshot to restore.

snapshotRestoreJobId String

The unique identifier of the restore job.

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

The name of the Atlas cluster whose snapshot you want to restore.

createdAt string

UTC ISO 8601 formatted point in time when Atlas created the restore job.

deliveryType {[key: string]: string}

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

deliveryTypeConfig CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

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.

projectId string

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshotId string

Unique identifier of the snapshot to restore.

snapshotRestoreJobId string

The unique identifier of the restore job.

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

The name of the Atlas cluster whose snapshot you want to restore.

created_at str

UTC ISO 8601 formatted point in time when Atlas created the restore job.

delivery_type Mapping[str, str]

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

delivery_type_config CloudProviderSnapshotRestoreJobDeliveryTypeConfigArgs

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.

project_id str

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshot_id str

Unique identifier of the snapshot to restore.

snapshot_restore_job_id str

The unique identifier of the restore job.

timestamp str

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

The name of the Atlas cluster whose snapshot you want to restore.

createdAt String

UTC ISO 8601 formatted point in time when Atlas created the restore job.

deliveryType Map<String>

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

Deprecated:

use delivery_type_config instead

deliveryTypeConfig Property Map

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 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.

projectId String

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

snapshotId String

Unique identifier of the snapshot to restore.

snapshotRestoreJobId String

The unique identifier of the restore job.

timestamp String

Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

Supporting Types

CloudProviderSnapshotRestoreJobDeliveryTypeConfig

Automated bool
Download bool
OplogInc int
OplogTs int
PointInTime bool
PointInTimeUtcSeconds int
TargetClusterName string

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

TargetProjectId string

Unique ID of the target Atlas project for the specified targetClusterName. Only required if deliveryType is automated.

Automated bool
Download bool
OplogInc int
OplogTs int
PointInTime bool
PointInTimeUtcSeconds int
TargetClusterName string

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

TargetProjectId string

Unique ID of the target Atlas project for the specified targetClusterName. Only required if deliveryType is automated.

automated Boolean
download Boolean
oplogInc Integer
oplogTs Integer
pointInTime Boolean
pointInTimeUtcSeconds Integer
targetClusterName String

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

targetProjectId String

Unique ID of the target Atlas project for the specified targetClusterName. Only required if deliveryType is automated.

automated boolean
download boolean
oplogInc number
oplogTs number
pointInTime boolean
pointInTimeUtcSeconds number
targetClusterName string

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

targetProjectId string

Unique ID of the target Atlas project for the specified targetClusterName. Only required if deliveryType is automated.

automated bool
download bool
oplog_inc int
oplog_ts int
point_in_time bool
point_in_time_utc_seconds int
target_cluster_name str

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

target_project_id str

Unique ID of the target Atlas project for the specified targetClusterName. Only required if deliveryType is automated.

automated Boolean
download Boolean
oplogInc Number
oplogTs Number
pointInTime Boolean
pointInTimeUtcSeconds Number
targetClusterName String

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

targetProjectId String

Unique ID of the target Atlas project for the specified targetClusterName. Only required if deliveryType is automated.

Import

Cloud Backup Snapshot Restore Job entries can be imported using project project_id, cluster_name and snapshot_id (Unique identifier of the snapshot), in the format PROJECTID-CLUSTERNAME-JOBID, e.g.

 $ pulumi import mongodbatlas:index/cloudProviderSnapshotRestoreJob:CloudProviderSnapshotRestoreJob test 5cf5a45a9ccf6400e60981b6-MyCluster-5d1b654ecf09a24b888f4c79

For more information seeMongoDB Atlas API Reference.

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.