MongoDB Atlas v3.30.0, Mar 21 25

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.CloudBackupSnapshotRestoreJob

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

Example Usage
Example automated delivery type
Example download delivery type
Example of a point in time restore
Available complete examples
Create CloudBackupSnapshotRestoreJob Resource
Constructor syntax
Constructor example
CloudBackupSnapshotRestoreJob Resource Properties
Inputs
Outputs
Look up Existing CloudBackupSnapshotRestoreJob Resource
Supporting Types
Import
Package Details

Request a Change

Example Usage

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

const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
    projectId: "<PROJECT-ID>",
    name: "MyCluster",
    clusterType: "REPLICASET",
    backupEnabled: true,
    replicationSpecs: [{
        regionConfigs: [{
            priority: 7,
            providerName: "AWS",
            regionName: "EU_WEST_2",
            electableSpecs: {
                instanceSize: "M10",
                nodeCount: 3,
            },
        }],
    }],
});
const test = new mongodbatlas.index.CloudProviderSnapshot("test", {
    projectId: myCluster.projectId,
    clusterName: myCluster.name,
    description: "myDescription",
    retentionInDays: 1,
});
const testCloudBackupSnapshotRestoreJob = new mongodbatlas.CloudBackupSnapshotRestoreJob("test", {
    projectId: test.projectId,
    clusterName: test.clusterName,
    snapshotId: test.snapshotId,
    deliveryTypeConfig: {
        automated: true,
        targetClusterName: "MyCluster",
        targetProjectId: "5cf5a45a9ccf6400e60981b6",
    },
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.AdvancedCluster("my_cluster",
    project_id="<PROJECT-ID>",
    name="MyCluster",
    cluster_type="REPLICASET",
    backup_enabled=True,
    replication_specs=[{
        "region_configs": [{
            "priority": 7,
            "provider_name": "AWS",
            "region_name": "EU_WEST_2",
            "electable_specs": {
                "instance_size": "M10",
                "node_count": 3,
            },
        }],
    }])
test = mongodbatlas.index.CloudProviderSnapshot("test",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description=myDescription,
    retention_in_days=1)
test_cloud_backup_snapshot_restore_job = mongodbatlas.CloudBackupSnapshotRestoreJob("test",
    project_id=test["projectId"],
    cluster_name=test["clusterName"],
    snapshot_id=test["snapshotId"],
    delivery_type_config={
        "automated": True,
        "target_cluster_name": "MyCluster",
        "target_project_id": "5cf5a45a9ccf6400e60981b6",
    })

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.NewAdvancedCluster(ctx, "my_cluster", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:     pulumi.String("<PROJECT-ID>"),
			Name:          pulumi.String("MyCluster"),
			ClusterType:   pulumi.String("REPLICASET"),
			BackupEnabled: pulumi.Bool(true),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							Priority:     pulumi.Int(7),
							ProviderName: pulumi.String("AWS"),
							RegionName:   pulumi.String("EU_WEST_2"),
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(3),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		test, err := mongodbatlas.NewCloudProviderSnapshot(ctx, "test", &mongodbatlas.CloudProviderSnapshotArgs{
			ProjectId:       myCluster.ProjectId,
			ClusterName:     myCluster.Name,
			Description:     "myDescription",
			RetentionInDays: 1,
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewCloudBackupSnapshotRestoreJob(ctx, "test", &mongodbatlas.CloudBackupSnapshotRestoreJobArgs{
			ProjectId:   test.ProjectId,
			ClusterName: test.ClusterName,
			SnapshotId:  test.SnapshotId,
			DeliveryTypeConfig: &mongodbatlas.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs{
				Automated:         pulumi.Bool(true),
				TargetClusterName: pulumi.String("MyCluster"),
				TargetProjectId:   pulumi.String("5cf5a45a9ccf6400e60981b6"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myCluster = new Mongodbatlas.AdvancedCluster("my_cluster", new()
    {
        ProjectId = "<PROJECT-ID>",
        Name = "MyCluster",
        ClusterType = "REPLICASET",
        BackupEnabled = true,
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        Priority = 7,
                        ProviderName = "AWS",
                        RegionName = "EU_WEST_2",
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 3,
                        },
                    },
                },
            },
        },
    });

    var test = new Mongodbatlas.Index.CloudProviderSnapshot("test", new()
    {
        ProjectId = myCluster.ProjectId,
        ClusterName = myCluster.Name,
        Description = "myDescription",
        RetentionInDays = 1,
    });

    var testCloudBackupSnapshotRestoreJob = new Mongodbatlas.CloudBackupSnapshotRestoreJob("test", new()
    {
        ProjectId = test.ProjectId,
        ClusterName = test.ClusterName,
        SnapshotId = test.SnapshotId,
        DeliveryTypeConfig = new Mongodbatlas.Inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs
        {
            Automated = true,
            TargetClusterName = "MyCluster",
            TargetProjectId = "5cf5a45a9ccf6400e60981b6",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.cloudProviderSnapshot;
import com.pulumi.mongodbatlas.CloudProviderSnapshotArgs;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs;
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 AdvancedCluster("myCluster", AdvancedClusterArgs.builder()
            .projectId("<PROJECT-ID>")
            .name("MyCluster")
            .clusterType("REPLICASET")
            .backupEnabled(true)
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .priority(7)
                    .providerName("AWS")
                    .regionName("EU_WEST_2")
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M10")
                        .nodeCount(3)
                        .build())
                    .build())
                .build())
            .build());

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

        var testCloudBackupSnapshotRestoreJob = new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob", CloudBackupSnapshotRestoreJobArgs.builder()
            .projectId(test.projectId())
            .clusterName(test.clusterName())
            .snapshotId(test.snapshotId())
            .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
                .automated(true)
                .targetClusterName("MyCluster")
                .targetProjectId("5cf5a45a9ccf6400e60981b6")
                .build())
            .build());

    }
}

resources:
  myCluster:
    type: mongodbatlas:AdvancedCluster
    name: my_cluster
    properties:
      projectId: <PROJECT-ID>
      name: MyCluster
      clusterType: REPLICASET
      backupEnabled: true # enable cloud backup snapshots
      replicationSpecs:
        - regionConfigs:
            - priority: 7
              providerName: AWS
              regionName: EU_WEST_2
              electableSpecs:
                instanceSize: M10
                nodeCount: 3
  test:
    type: mongodbatlas:cloudProviderSnapshot
    properties:
      projectId: ${myCluster.projectId}
      clusterName: ${myCluster.name}
      description: myDescription
      retentionInDays: 1
  testCloudBackupSnapshotRestoreJob:
    type: mongodbatlas:CloudBackupSnapshotRestoreJob
    name: test
    properties:
      projectId: ${test.projectId}
      clusterName: ${test.clusterName}
      snapshotId: ${test.snapshotId}
      deliveryTypeConfig:
        automated: true
        targetClusterName: MyCluster
        targetProjectId: 5cf5a45a9ccf6400e60981b6

Example download delivery type

TypeScript
Python
Go
C#
Java
YAML

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

const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
    projectId: "<PROJECT-ID>",
    name: "MyCluster",
    clusterType: "REPLICASET",
    backupEnabled: true,
    replicationSpecs: [{
        regionConfigs: [{
            priority: 7,
            providerName: "AWS",
            regionName: "EU_WEST_2",
            electableSpecs: {
                instanceSize: "M10",
                nodeCount: 3,
            },
        }],
    }],
});
const test = new mongodbatlas.index.CloudProviderSnapshot("test", {
    projectId: myCluster.projectId,
    clusterName: myCluster.name,
    description: "myDescription",
    retentionInDays: 1,
});
const testCloudBackupSnapshotRestoreJob = new mongodbatlas.CloudBackupSnapshotRestoreJob("test", {
    projectId: test.projectId,
    clusterName: test.clusterName,
    snapshotId: test.snapshotId,
    deliveryTypeConfig: {
        download: true,
    },
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.AdvancedCluster("my_cluster",
    project_id="<PROJECT-ID>",
    name="MyCluster",
    cluster_type="REPLICASET",
    backup_enabled=True,
    replication_specs=[{
        "region_configs": [{
            "priority": 7,
            "provider_name": "AWS",
            "region_name": "EU_WEST_2",
            "electable_specs": {
                "instance_size": "M10",
                "node_count": 3,
            },
        }],
    }])
test = mongodbatlas.index.CloudProviderSnapshot("test",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description=myDescription,
    retention_in_days=1)
test_cloud_backup_snapshot_restore_job = mongodbatlas.CloudBackupSnapshotRestoreJob("test",
    project_id=test["projectId"],
    cluster_name=test["clusterName"],
    snapshot_id=test["snapshotId"],
    delivery_type_config={
        "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.NewAdvancedCluster(ctx, "my_cluster", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:     pulumi.String("<PROJECT-ID>"),
			Name:          pulumi.String("MyCluster"),
			ClusterType:   pulumi.String("REPLICASET"),
			BackupEnabled: pulumi.Bool(true),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							Priority:     pulumi.Int(7),
							ProviderName: pulumi.String("AWS"),
							RegionName:   pulumi.String("EU_WEST_2"),
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(3),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		test, err := mongodbatlas.NewCloudProviderSnapshot(ctx, "test", &mongodbatlas.CloudProviderSnapshotArgs{
			ProjectId:       myCluster.ProjectId,
			ClusterName:     myCluster.Name,
			Description:     "myDescription",
			RetentionInDays: 1,
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewCloudBackupSnapshotRestoreJob(ctx, "test", &mongodbatlas.CloudBackupSnapshotRestoreJobArgs{
			ProjectId:   test.ProjectId,
			ClusterName: test.ClusterName,
			SnapshotId:  test.SnapshotId,
			DeliveryTypeConfig: &mongodbatlas.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs{
				Download: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myCluster = new Mongodbatlas.AdvancedCluster("my_cluster", new()
    {
        ProjectId = "<PROJECT-ID>",
        Name = "MyCluster",
        ClusterType = "REPLICASET",
        BackupEnabled = true,
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        Priority = 7,
                        ProviderName = "AWS",
                        RegionName = "EU_WEST_2",
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 3,
                        },
                    },
                },
            },
        },
    });

    var test = new Mongodbatlas.Index.CloudProviderSnapshot("test", new()
    {
        ProjectId = myCluster.ProjectId,
        ClusterName = myCluster.Name,
        Description = "myDescription",
        RetentionInDays = 1,
    });

    var testCloudBackupSnapshotRestoreJob = new Mongodbatlas.CloudBackupSnapshotRestoreJob("test", new()
    {
        ProjectId = test.ProjectId,
        ClusterName = test.ClusterName,
        SnapshotId = test.SnapshotId,
        DeliveryTypeConfig = new Mongodbatlas.Inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs
        {
            Download = true,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.cloudProviderSnapshot;
import com.pulumi.mongodbatlas.CloudProviderSnapshotArgs;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs;
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 AdvancedCluster("myCluster", AdvancedClusterArgs.builder()
            .projectId("<PROJECT-ID>")
            .name("MyCluster")
            .clusterType("REPLICASET")
            .backupEnabled(true)
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .priority(7)
                    .providerName("AWS")
                    .regionName("EU_WEST_2")
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M10")
                        .nodeCount(3)
                        .build())
                    .build())
                .build())
            .build());

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

        var testCloudBackupSnapshotRestoreJob = new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob", CloudBackupSnapshotRestoreJobArgs.builder()
            .projectId(test.projectId())
            .clusterName(test.clusterName())
            .snapshotId(test.snapshotId())
            .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
                .download(true)
                .build())
            .build());

    }
}

resources:
  myCluster:
    type: mongodbatlas:AdvancedCluster
    name: my_cluster
    properties:
      projectId: <PROJECT-ID>
      name: MyCluster
      clusterType: REPLICASET
      backupEnabled: true # enable cloud backup snapshots
      replicationSpecs:
        - regionConfigs:
            - priority: 7
              providerName: AWS
              regionName: EU_WEST_2
              electableSpecs:
                instanceSize: M10
                nodeCount: 3
  test:
    type: mongodbatlas:cloudProviderSnapshot
    properties:
      projectId: ${myCluster.projectId}
      clusterName: ${myCluster.name}
      description: myDescription
      retentionInDays: 1
  testCloudBackupSnapshotRestoreJob:
    type: mongodbatlas:CloudBackupSnapshotRestoreJob
    name: test
    properties:
      projectId: ${test.projectId}
      clusterName: ${test.clusterName}
      snapshotId: ${test.snapshotId}
      deliveryTypeConfig:
        download: true

Example of a point in time restore

TypeScript
Python
Go
C#
Java
YAML

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

const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
    projectId: "<PROJECT-ID>",
    name: "MyCluster",
    clusterType: "REPLICASET",
    backupEnabled: true,
    replicationSpecs: [{
        regionConfigs: [{
            priority: 7,
            providerName: "AWS",
            regionName: "EU_WEST_2",
            electableSpecs: {
                instanceSize: "M10",
                nodeCount: 3,
            },
        }],
    }],
});
const test = new mongodbatlas.CloudBackupSnapshot("test", {
    projectId: clusterTest.projectId,
    clusterName: clusterTest.name,
    description: "My description",
    retentionInDays: 1,
});
const testCloudBackupSnapshotRestoreJob: mongodbatlas.CloudBackupSnapshotRestoreJob[] = [];
for (const range = {value: 0}; range.value < (pointInTimeUtcSeconds == 0 ? 0 : 1); range.value++) {
    testCloudBackupSnapshotRestoreJob.push(new mongodbatlas.CloudBackupSnapshotRestoreJob(`test-${range.value}`, {
        projectId: test.projectId,
        clusterName: test.clusterName,
        snapshotId: test.id,
        deliveryTypeConfig: {
            pointInTime: true,
            targetClusterName: clusterTest.name,
            targetProjectId: clusterTest.projectId,
            pointInTimeUtcSeconds: pointInTimeUtcSeconds,
        },
    }));
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.AdvancedCluster("my_cluster",
    project_id="<PROJECT-ID>",
    name="MyCluster",
    cluster_type="REPLICASET",
    backup_enabled=True,
    replication_specs=[{
        "region_configs": [{
            "priority": 7,
            "provider_name": "AWS",
            "region_name": "EU_WEST_2",
            "electable_specs": {
                "instance_size": "M10",
                "node_count": 3,
            },
        }],
    }])
test = mongodbatlas.CloudBackupSnapshot("test",
    project_id=cluster_test["projectId"],
    cluster_name=cluster_test["name"],
    description="My description",
    retention_in_days=1)
test_cloud_backup_snapshot_restore_job = []
for range in [{"value": i} for i in range(0, 0 if point_in_time_utc_seconds == 0 else 1)]:
    test_cloud_backup_snapshot_restore_job.append(mongodbatlas.CloudBackupSnapshotRestoreJob(f"test-{range['value']}",
        project_id=test.project_id,
        cluster_name=test.cluster_name,
        snapshot_id=test.id,
        delivery_type_config={
            "point_in_time": True,
            "target_cluster_name": cluster_test["name"],
            "target_project_id": cluster_test["projectId"],
            "point_in_time_utc_seconds": point_in_time_utc_seconds,
        }))

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 {
		_, err := mongodbatlas.NewAdvancedCluster(ctx, "my_cluster", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:     pulumi.String("<PROJECT-ID>"),
			Name:          pulumi.String("MyCluster"),
			ClusterType:   pulumi.String("REPLICASET"),
			BackupEnabled: pulumi.Bool(true),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							Priority:     pulumi.Int(7),
							ProviderName: pulumi.String("AWS"),
							RegionName:   pulumi.String("EU_WEST_2"),
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(3),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		test, err := mongodbatlas.NewCloudBackupSnapshot(ctx, "test", &mongodbatlas.CloudBackupSnapshotArgs{
			ProjectId:       pulumi.Any(clusterTest.ProjectId),
			ClusterName:     pulumi.Any(clusterTest.Name),
			Description:     pulumi.String("My description"),
			RetentionInDays: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		var tmp0 float64
		if pointInTimeUtcSeconds == 0 {
			tmp0 = 0
		} else {
			tmp0 = 1
		}
		var testCloudBackupSnapshotRestoreJob []*mongodbatlas.CloudBackupSnapshotRestoreJob
		for index := 0; index < tmp0; index++ {
			key0 := index
			_ := index
			__res, err := mongodbatlas.NewCloudBackupSnapshotRestoreJob(ctx, fmt.Sprintf("test-%v", key0), &mongodbatlas.CloudBackupSnapshotRestoreJobArgs{
				ProjectId:   test.ProjectId,
				ClusterName: test.ClusterName,
				SnapshotId:  test.ID(),
				DeliveryTypeConfig: &mongodbatlas.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs{
					PointInTime:           pulumi.Bool(true),
					TargetClusterName:     pulumi.Any(clusterTest.Name),
					TargetProjectId:       pulumi.Any(clusterTest.ProjectId),
					PointInTimeUtcSeconds: pulumi.Any(pointInTimeUtcSeconds),
				},
			})
			if err != nil {
				return err
			}
			testCloudBackupSnapshotRestoreJob = append(testCloudBackupSnapshotRestoreJob, __res)
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myCluster = new Mongodbatlas.AdvancedCluster("my_cluster", new()
    {
        ProjectId = "<PROJECT-ID>",
        Name = "MyCluster",
        ClusterType = "REPLICASET",
        BackupEnabled = true,
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        Priority = 7,
                        ProviderName = "AWS",
                        RegionName = "EU_WEST_2",
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 3,
                        },
                    },
                },
            },
        },
    });

    var test = new Mongodbatlas.CloudBackupSnapshot("test", new()
    {
        ProjectId = clusterTest.ProjectId,
        ClusterName = clusterTest.Name,
        Description = "My description",
        RetentionInDays = 1,
    });

    var testCloudBackupSnapshotRestoreJob = new List<Mongodbatlas.CloudBackupSnapshotRestoreJob>();
    for (var rangeIndex = 0; rangeIndex < (pointInTimeUtcSeconds == 0 ? 0 : 1); rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        testCloudBackupSnapshotRestoreJob.Add(new Mongodbatlas.CloudBackupSnapshotRestoreJob($"test-{range.Value}", new()
        {
            ProjectId = test.ProjectId,
            ClusterName = test.ClusterName,
            SnapshotId = test.Id,
            DeliveryTypeConfig = new Mongodbatlas.Inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs
            {
                PointInTime = true,
                TargetClusterName = clusterTest.Name,
                TargetProjectId = clusterTest.ProjectId,
                PointInTimeUtcSeconds = pointInTimeUtcSeconds,
            },
        }));
    }
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.CloudBackupSnapshot;
import com.pulumi.mongodbatlas.CloudBackupSnapshotArgs;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs;
import com.pulumi.codegen.internal.KeyedValue;
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 AdvancedCluster("myCluster", AdvancedClusterArgs.builder()
            .projectId("<PROJECT-ID>")
            .name("MyCluster")
            .clusterType("REPLICASET")
            .backupEnabled(true)
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .priority(7)
                    .providerName("AWS")
                    .regionName("EU_WEST_2")
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M10")
                        .nodeCount(3)
                        .build())
                    .build())
                .build())
            .build());

        var test = new CloudBackupSnapshot("test", CloudBackupSnapshotArgs.builder()
            .projectId(clusterTest.projectId())
            .clusterName(clusterTest.name())
            .description("My description")
            .retentionInDays("1")
            .build());

        for (var i = 0; i < (pointInTimeUtcSeconds == 0 ? 0 : 1); i++) {
            new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob-" + i, CloudBackupSnapshotRestoreJobArgs.builder()
                .projectId(test.projectId())
                .clusterName(test.clusterName())
                .snapshotId(test.id())
                .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
                    .pointInTime(true)
                    .targetClusterName(clusterTest.name())
                    .targetProjectId(clusterTest.projectId())
                    .pointInTimeUtcSeconds(pointInTimeUtcSeconds)
                    .build())
                .build());

        
}
    }
}

resources:
  myCluster:
    type: mongodbatlas:AdvancedCluster
    name: my_cluster
    properties:
      projectId: <PROJECT-ID>
      name: MyCluster
      clusterType: REPLICASET
      backupEnabled: true # enable cloud backup snapshots
      replicationSpecs:
        - regionConfigs:
            - priority: 7
              providerName: AWS
              regionName: EU_WEST_2
              electableSpecs:
                instanceSize: M10
                nodeCount: 3
  test:
    type: mongodbatlas:CloudBackupSnapshot
    properties:
      projectId: ${clusterTest.projectId}
      clusterName: ${clusterTest.name}
      description: My description
      retentionInDays: '1'
  testCloudBackupSnapshotRestoreJob:
    type: mongodbatlas:CloudBackupSnapshotRestoreJob
    name: test
    properties:
      projectId: ${test.projectId}
      clusterName: ${test.clusterName}
      snapshotId: ${test.id}
      deliveryTypeConfig:
        pointInTime: true
        targetClusterName: ${clusterTest.name}
        targetProjectId: ${clusterTest.projectId}
        pointInTimeUtcSeconds: ${pointInTimeUtcSeconds}
    options: {}

Available complete examples

Restore from backup snapshot at point in time
Restore from backup snapshot using an advanced cluster resource

Create CloudBackupSnapshotRestoreJob Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new CloudBackupSnapshotRestoreJob(name: string, args: CloudBackupSnapshotRestoreJobArgs, opts?: CustomResourceOptions);

@overload
def CloudBackupSnapshotRestoreJob(resource_name: str,
                                  args: CloudBackupSnapshotRestoreJobArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def CloudBackupSnapshotRestoreJob(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  cluster_name: Optional[str] = None,
                                  project_id: Optional[str] = None,
                                  delivery_type_config: Optional[CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs] = None,
                                  snapshot_id: Optional[str] = None)

func NewCloudBackupSnapshotRestoreJob(ctx *Context, name string, args CloudBackupSnapshotRestoreJobArgs, opts ...ResourceOption) (*CloudBackupSnapshotRestoreJob, error)

public CloudBackupSnapshotRestoreJob(string name, CloudBackupSnapshotRestoreJobArgs args, CustomResourceOptions? opts = null)

public CloudBackupSnapshotRestoreJob(String name, CloudBackupSnapshotRestoreJobArgs args)
public CloudBackupSnapshotRestoreJob(String name, CloudBackupSnapshotRestoreJobArgs args, CustomResourceOptions options)

type: mongodbatlas:CloudBackupSnapshotRestoreJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args CloudBackupSnapshotRestoreJobArgs: 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 CloudBackupSnapshotRestoreJobArgs: 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 CloudBackupSnapshotRestoreJobArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CloudBackupSnapshotRestoreJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CloudBackupSnapshotRestoreJobArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var cloudBackupSnapshotRestoreJobResource = new Mongodbatlas.CloudBackupSnapshotRestoreJob("cloudBackupSnapshotRestoreJobResource", new()
{
    ClusterName = "string",
    ProjectId = "string",
    DeliveryTypeConfig = new Mongodbatlas.Inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs
    {
        Automated = false,
        Download = false,
        OplogInc = 0,
        OplogTs = 0,
        PointInTime = false,
        PointInTimeUtcSeconds = 0,
        TargetClusterName = "string",
        TargetProjectId = "string",
    },
    SnapshotId = "string",
});

example, err := mongodbatlas.NewCloudBackupSnapshotRestoreJob(ctx, "cloudBackupSnapshotRestoreJobResource", &mongodbatlas.CloudBackupSnapshotRestoreJobArgs{
	ClusterName: pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	DeliveryTypeConfig: &mongodbatlas.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs{
		Automated:             pulumi.Bool(false),
		Download:              pulumi.Bool(false),
		OplogInc:              pulumi.Int(0),
		OplogTs:               pulumi.Int(0),
		PointInTime:           pulumi.Bool(false),
		PointInTimeUtcSeconds: pulumi.Int(0),
		TargetClusterName:     pulumi.String("string"),
		TargetProjectId:       pulumi.String("string"),
	},
	SnapshotId: pulumi.String("string"),
})

var cloudBackupSnapshotRestoreJobResource = new CloudBackupSnapshotRestoreJob("cloudBackupSnapshotRestoreJobResource", CloudBackupSnapshotRestoreJobArgs.builder()
    .clusterName("string")
    .projectId("string")
    .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
        .automated(false)
        .download(false)
        .oplogInc(0)
        .oplogTs(0)
        .pointInTime(false)
        .pointInTimeUtcSeconds(0)
        .targetClusterName("string")
        .targetProjectId("string")
        .build())
    .snapshotId("string")
    .build());

cloud_backup_snapshot_restore_job_resource = mongodbatlas.CloudBackupSnapshotRestoreJob("cloudBackupSnapshotRestoreJobResource",
    cluster_name="string",
    project_id="string",
    delivery_type_config={
        "automated": False,
        "download": False,
        "oplog_inc": 0,
        "oplog_ts": 0,
        "point_in_time": False,
        "point_in_time_utc_seconds": 0,
        "target_cluster_name": "string",
        "target_project_id": "string",
    },
    snapshot_id="string")

const cloudBackupSnapshotRestoreJobResource = new mongodbatlas.CloudBackupSnapshotRestoreJob("cloudBackupSnapshotRestoreJobResource", {
    clusterName: "string",
    projectId: "string",
    deliveryTypeConfig: {
        automated: false,
        download: false,
        oplogInc: 0,
        oplogTs: 0,
        pointInTime: false,
        pointInTimeUtcSeconds: 0,
        targetClusterName: "string",
        targetProjectId: "string",
    },
    snapshotId: "string",
});

type: mongodbatlas:CloudBackupSnapshotRestoreJob
properties:
    clusterName: string
    deliveryTypeConfig:
        automated: false
        download: false
        oplogInc: 0
        oplogTs: 0
        pointInTime: false
        pointInTimeUtcSeconds: 0
        targetClusterName: string
        targetProjectId: string
    projectId: string
    snapshotId: string

CloudBackupSnapshotRestoreJob Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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

DeliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfig

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

SnapshotId string

Optional setting for pointInTime configuration. Unique identifier of the snapshot to restore.

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.

DeliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

SnapshotId string

Optional setting for pointInTime configuration. Unique identifier of the snapshot to restore.

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.

deliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfig

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

snapshotId String

Optional setting for pointInTime configuration. Unique identifier of the snapshot to restore.

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.

deliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfig

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

snapshotId string

Optional setting for pointInTime configuration. Unique identifier of the snapshot to restore.

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.

delivery_type_config CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

snapshot_id str

Optional setting for pointInTime configuration. Unique identifier of the snapshot to restore.

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.

deliveryTypeConfig Property Map

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

snapshotId String

Optional setting for pointInTime configuration. Unique identifier of the snapshot to restore.

Outputs

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

Cancelled bool

Indicates whether the restore job was canceled.

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.

Failed bool

Indicates whether the restore job failed.

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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

Cancelled bool

Indicates whether the restore job was canceled.

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.

Failed bool

Indicates whether the restore job failed.

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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled Boolean

Indicates whether the restore job was canceled.

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.

failed Boolean

Indicates whether the restore job failed.

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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled boolean

Indicates whether the restore job was canceled.

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.

failed boolean

Indicates whether the restore job failed.

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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled bool

Indicates whether the restore job was canceled.

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.

failed bool

Indicates whether the restore job failed.

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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled Boolean

Indicates whether the restore job was canceled.

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.

failed Boolean

Indicates whether the restore job failed.

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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

Look up Existing CloudBackupSnapshotRestoreJob Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: CloudBackupSnapshotRestoreJobState, opts?: CustomResourceOptions): CloudBackupSnapshotRestoreJob

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cancelled: Optional[bool] = None,
        cluster_name: Optional[str] = None,
        delivery_type_config: Optional[CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs] = None,
        delivery_urls: Optional[Sequence[str]] = None,
        expired: Optional[bool] = None,
        expires_at: Optional[str] = None,
        failed: Optional[bool] = 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) -> CloudBackupSnapshotRestoreJob

func GetCloudBackupSnapshotRestoreJob(ctx *Context, name string, id IDInput, state *CloudBackupSnapshotRestoreJobState, opts ...ResourceOption) (*CloudBackupSnapshotRestoreJob, error)

public static CloudBackupSnapshotRestoreJob Get(string name, Input<string> id, CloudBackupSnapshotRestoreJobState? state, CustomResourceOptions? opts = null)

public static CloudBackupSnapshotRestoreJob get(String name, Output<String> id, CloudBackupSnapshotRestoreJobState state, CustomResourceOptions options)

resources:  _:    type: mongodbatlas:CloudBackupSnapshotRestoreJob    get:      id: ${id}

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.

DeliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfig

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

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.

Failed bool

Indicates whether the restore job failed.

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

Optional setting for pointInTime configuration. 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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

Cancelled bool

Indicates whether the restore job was canceled.

ClusterName string

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

DeliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

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.

Failed bool

Indicates whether the restore job failed.

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

Optional setting for pointInTime configuration. 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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled Boolean

Indicates whether the restore job was canceled.

clusterName String

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

deliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfig

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

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.

failed Boolean

Indicates whether the restore job failed.

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

Optional setting for pointInTime configuration. 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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled boolean

Indicates whether the restore job was canceled.

clusterName string

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

deliveryTypeConfig CloudBackupSnapshotRestoreJobDeliveryTypeConfig

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

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.

failed boolean

Indicates whether the restore job failed.

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

Optional setting for pointInTime configuration. 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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled bool

Indicates whether the restore job was canceled.

cluster_name str

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

delivery_type_config CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

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.

failed bool

Indicates whether the restore job failed.

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

Optional setting for pointInTime configuration. 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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

cancelled Boolean

Indicates whether the restore job was canceled.

clusterName String

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

deliveryTypeConfig Property Map

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

delivery_type_config.automated - Set to true to use the automated configuration.
delivery_type_config.download - Set to true to use the download configuration.
delivery_type_config.pointInTime - Set to true to use the pointInTime configuration. If using pointInTime configuration, you must also specify either oplog_ts and oplog_inc, or point_in_time_utc_seconds.
delivery_type_config.target_cluster_name - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.target_project_id - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for automated and pointInTime.
delivery_type_config.oplog_ts - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
delivery_type_config.oplog_inc - Optional setting for pointInTime configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with oplog_ts.
delivery_type_config.point_in_time_utc_seconds - Optional setting for pointInTime configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.

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.

failed Boolean

Indicates whether the restore job failed.

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

Optional setting for pointInTime configuration. 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.

oplogTs - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogInc.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
oplogInc - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Three conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify oplogTs.
Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Two conditions apply to this parameter:
Enable Continuous Cloud Backup on your cluster.
Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.

Supporting Types

CloudBackupSnapshotRestoreJobDeliveryTypeConfig
, CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

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 visible if deliveryType is automated.
TargetProjectId string: Name of the target Atlas project of the restore job. Only visible 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 visible if deliveryType is automated.
TargetProjectId string: Name of the target Atlas project of the restore job. Only visible 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 visible if deliveryType is automated.
targetProjectId String: Name of the target Atlas project of the restore job. Only visible 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 visible if deliveryType is automated.
targetProjectId string: Name of the target Atlas project of the restore job. Only visible 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 visible if deliveryType is automated.
target_project_id str: Name of the target Atlas project of the restore job. Only visible 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 visible if deliveryType is automated.
targetProjectId String: Name of the target Atlas project of the restore job. Only visible 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/cloudBackupSnapshotRestoreJob:CloudBackupSnapshotRestoreJob test 5cf5a45a9ccf6400e60981b6-MyCluster-5d1b654ecf09a24b888f4c79

For more information see: MongoDB Atlas API Reference.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

Example Usage
Example automated delivery type
Example download delivery type
Example of a point in time restore
Available complete examples
Create CloudBackupSnapshotRestoreJob Resource
Constructor syntax
Constructor example
CloudBackupSnapshotRestoreJob Resource Properties
Inputs
Outputs
Look up Existing CloudBackupSnapshotRestoreJob Resource
Supporting Types
Import
Package Details

Request a Change

mongodbatlas.CloudBackupSnapshotRestoreJob

On this page

On this page

Example Usage

Example automated delivery type

Example download delivery type

Example of a point in time restore

Available complete examples

Create CloudBackupSnapshotRestoreJob Resource

Constructor syntax

Parameters

Constructor example

CloudBackupSnapshotRestoreJob Resource Properties

Inputs

Outputs

Look up Existing CloudBackupSnapshotRestoreJob Resource

Supporting Types

CloudBackupSnapshotRestoreJobDeliveryTypeConfig
, CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

Import

Package Details

On this page

On this page

mongodbatlas.CloudBackupSnapshotRestoreJob

On this page

On this page

Example Usage

Example automated delivery type

Example download delivery type

Example of a point in time restore

Available complete examples

Create CloudBackupSnapshotRestoreJob Resource

Constructor syntax

Parameters

Constructor example

CloudBackupSnapshotRestoreJob Resource Properties

Inputs

Outputs

Look up Existing CloudBackupSnapshotRestoreJob Resource

Supporting Types

CloudBackupSnapshotRestoreJobDeliveryTypeConfig, CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs

Import

Package Details

On this page

On this page

CloudBackupSnapshotRestoreJobDeliveryTypeConfig
, CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs