Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getCloudBackupSnapshotRestoreJob
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSnapshotRestoreJob

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.CloudBackupSnapshotRestoreJob

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

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

Example Usage

First create a snapshot of the desired cluster. Then request that snapshot be restored in an automated fashion to the designated cluster and project.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  testCloudBackupSnapshot:
    type: mongodbatlas:CloudBackupSnapshot
    name: test
    properties:
      projectId: 5cf5a45a9ccf6400e60981b6
      clusterName: MyCluster
      description: MyDescription
      retentionInDays: 1
  testCloudBackupSnapshotRestoreJob:
    type: mongodbatlas:CloudBackupSnapshotRestoreJob
    name: test
    properties:
      projectId: 5cf5a45a9ccf6400e60981b6
      clusterName: MyCluster
      snapshotId: ${testCloudBackupSnapshot.id}
      deliveryType:
        - automated: true
          targetClusterName: MyCluster
          targetProjectId: 5cf5a45a9ccf6400e60981b6
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getCloudBackupSnapshotRestoreJob
      arguments:
        projectId: ${testCloudBackupSnapshotRestoreJob.projectId}
        clusterName: ${testCloudBackupSnapshotRestoreJob.clusterName}
        snapshotRestoreJobId: ${testCloudBackupSnapshotRestoreJob.snapshotRestoreJobId}
Copy

Using getCloudBackupSnapshotRestoreJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCloudBackupSnapshotRestoreJob(args: GetCloudBackupSnapshotRestoreJobArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotRestoreJobResult>
function getCloudBackupSnapshotRestoreJobOutput(args: GetCloudBackupSnapshotRestoreJobOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotRestoreJobResult>
Copy
def get_cloud_backup_snapshot_restore_job(cluster_name: Optional[str] = None,
                                          project_id: Optional[str] = None,
                                          snapshot_restore_job_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotRestoreJobResult
def get_cloud_backup_snapshot_restore_job_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                          project_id: Optional[pulumi.Input[str]] = None,
                                          snapshot_restore_job_id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetCloudBackupSnapshotRestoreJobResult]
Copy
func LookupCloudBackupSnapshotRestoreJob(ctx *Context, args *LookupCloudBackupSnapshotRestoreJobArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotRestoreJobResult, error)
func LookupCloudBackupSnapshotRestoreJobOutput(ctx *Context, args *LookupCloudBackupSnapshotRestoreJobOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotRestoreJobResultOutput
Copy

> Note: This function is named LookupCloudBackupSnapshotRestoreJob in the Go SDK.

public static class GetCloudBackupSnapshotRestoreJob 
{
    public static Task<GetCloudBackupSnapshotRestoreJobResult> InvokeAsync(GetCloudBackupSnapshotRestoreJobArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotRestoreJobResult> Invoke(GetCloudBackupSnapshotRestoreJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudBackupSnapshotRestoreJobResult> getCloudBackupSnapshotRestoreJob(GetCloudBackupSnapshotRestoreJobArgs args, InvokeOptions options)
public static Output<GetCloudBackupSnapshotRestoreJobResult> getCloudBackupSnapshotRestoreJob(GetCloudBackupSnapshotRestoreJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getCloudBackupSnapshotRestoreJob:getCloudBackupSnapshotRestoreJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Atlas cluster for which you want to retrieve the restore job.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier of the project for the Atlas cluster.
SnapshotRestoreJobId This property is required. string
The unique identifier of the restore job to retrieve.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Atlas cluster for which you want to retrieve the restore job.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier of the project for the Atlas cluster.
SnapshotRestoreJobId This property is required. string
The unique identifier of the restore job to retrieve.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Atlas cluster for which you want to retrieve the restore job.
projectId
This property is required.
Changes to this property will trigger replacement.
String
The unique identifier of the project for the Atlas cluster.
snapshotRestoreJobId This property is required. String
The unique identifier of the restore job to retrieve.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Atlas cluster for which you want to retrieve the restore job.
projectId
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier of the project for the Atlas cluster.
snapshotRestoreJobId This property is required. string
The unique identifier of the restore job to retrieve.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Atlas cluster for which you want to retrieve the restore job.
project_id
This property is required.
Changes to this property will trigger replacement.
str
The unique identifier of the project for the Atlas cluster.
snapshot_restore_job_id This property is required. str
The unique identifier of the restore job to retrieve.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Atlas cluster for which you want to retrieve the restore job.
projectId
This property is required.
Changes to this property will trigger replacement.
String
The unique identifier of the project for the Atlas cluster.
snapshotRestoreJobId This property is required. String
The unique identifier of the restore job to retrieve.

getCloudBackupSnapshotRestoreJob Result

The following output properties are available:

Cancelled bool
Indicates whether the restore job was canceled.
ClusterName string
DeliveryType string
Type of restore job to create. Possible values are: automated and download.
DeliveryUrls List<string>
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
Expired bool
Indicates whether the restore job expired.
ExpiresAt string
UTC ISO 8601 formatted point in time when the restore job expires.
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.
OplogInc int
OplogTs int
PointInTimeUtcSeconds int
ProjectId string
SnapshotId string
Unique identifier of the source snapshot ID of the restore job.
SnapshotRestoreJobId string
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.
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.
  • oplogInc - Oplog operation number from which to you want to restore this snapshot.
  • pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
Cancelled bool
Indicates whether the restore job was canceled.
ClusterName string
DeliveryType string
Type of restore job to create. Possible values are: automated and download.
DeliveryUrls []string
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
Expired bool
Indicates whether the restore job expired.
ExpiresAt string
UTC ISO 8601 formatted point in time when the restore job expires.
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.
OplogInc int
OplogTs int
PointInTimeUtcSeconds int
ProjectId string
SnapshotId string
Unique identifier of the source snapshot ID of the restore job.
SnapshotRestoreJobId string
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.
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.
  • oplogInc - Oplog operation number from which to you want to restore this snapshot.
  • pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
cancelled Boolean
Indicates whether the restore job was canceled.
clusterName String
deliveryType String
Type of restore job to create. Possible values are: automated and download.
deliveryUrls List<String>
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired 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.
oplogInc Integer
oplogTs Integer
pointInTimeUtcSeconds Integer
projectId String
snapshotId String
Unique identifier of the source snapshot ID of the restore job.
snapshotRestoreJobId String
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.
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.
  • oplogInc - Oplog operation number from which to you want to restore this snapshot.
  • pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
cancelled boolean
Indicates whether the restore job was canceled.
clusterName string
deliveryType string
Type of restore job to create. Possible values are: automated and download.
deliveryUrls string[]
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired boolean
Indicates whether the restore job expired.
expiresAt string
UTC ISO 8601 formatted point in time when the restore job expires.
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.
oplogInc number
oplogTs number
pointInTimeUtcSeconds number
projectId string
snapshotId string
Unique identifier of the source snapshot ID of the restore job.
snapshotRestoreJobId string
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.
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.
  • oplogInc - Oplog operation number from which to you want to restore this snapshot.
  • pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
cancelled bool
Indicates whether the restore job was canceled.
cluster_name str
delivery_type str
Type of restore job to create. Possible values are: automated and download.
delivery_urls Sequence[str]
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired bool
Indicates whether the restore job expired.
expires_at str
UTC ISO 8601 formatted point in time when the restore job expires.
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.
oplog_inc int
oplog_ts int
point_in_time_utc_seconds int
project_id str
snapshot_id str
Unique identifier of the source snapshot ID of the restore job.
snapshot_restore_job_id str
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.
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.
  • oplogInc - Oplog operation number from which to you want to restore this snapshot.
  • pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
cancelled Boolean
Indicates whether the restore job was canceled.
clusterName String
deliveryType String
Type of restore job to create. Possible values are: automated and download.
deliveryUrls List<String>
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired 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.
oplogInc Number
oplogTs Number
pointInTimeUtcSeconds Number
projectId String
snapshotId String
Unique identifier of the source snapshot ID of the restore job.
snapshotRestoreJobId String
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.
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.
  • oplogInc - Oplog operation number from which to you want to restore this snapshot.
  • pointInTimeUTCSeconds - Timestamp in the number of seconds that have elapsed since the UNIX epoch.

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