published on Friday, Aug 28, 2026 by Pulumi
published on Friday, Aug 28, 2026 by Pulumi
mongodbatlas.CloudBackupCollectionRestoreJob provides a resource to restore selected databases or collections from a Cloud Backup snapshot or point in time into an existing Atlas cluster.
To use this resource, the requesting Service Account or API Key must have the Backup Manager or Project Owner role on the source project and on the target project.
Note: Create waits until the job
stateisSUCCESSFUL. Pending states areINITIALIZING,IN_PROGRESS, andFINALIZING. The default create timeout is 3 hours and is overridable withtimeouts.create. The job cannot be updated. Destroy only removes the resource from state; Atlas has no public cancel API, so there is nodeleteOnCreateTimeout. Provide eithersnapshotIdor point-in-time fields (pointInTimeUtcSeconds,oplogTs,oplogInc), not both. Per-collection progress is empty while the job isINITIALIZING. Cross-organization restore is not available with programmatic credentials; restore across projects in the same organization by settingtargetProjectIdandtargetClusterName.
Limitations
Atlas product limits apply. See Restore from Selected Databases and Collections for the full list.
- One collection-restore job per cluster at a time.
- Does not restore Atlas Search indexes. Skips views, time-series, and queryable encryption collections.
- Data transfer uses the public internet even when private endpoints exist.
- NVMe clusters and fallback snapshots are unsupported.
- Up to 100 databases and 100 explicitly listed collections per job.
Create CloudBackupCollectionRestoreJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CloudBackupCollectionRestoreJob(name: string, args: CloudBackupCollectionRestoreJobArgs, opts?: CustomResourceOptions);@overload
def CloudBackupCollectionRestoreJob(resource_name: str,
args: CloudBackupCollectionRestoreJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CloudBackupCollectionRestoreJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
write_strategy: Optional[str] = None,
target_project_id: Optional[str] = None,
cluster_name: Optional[str] = None,
target_cluster_name: Optional[str] = None,
index_strategy: Optional[str] = None,
database_suffix: Optional[str] = None,
oplog_ts: Optional[int] = None,
point_in_time_utc_seconds: Optional[int] = None,
oplog_inc: Optional[int] = None,
snapshot_id: Optional[str] = None,
databases: Optional[Sequence[CloudBackupCollectionRestoreJobDatabaseArgs]] = None,
collections: Optional[Sequence[CloudBackupCollectionRestoreJobCollectionArgs]] = None,
timeouts: Optional[CloudBackupCollectionRestoreJobTimeoutsArgs] = None,
collection_suffix: Optional[str] = None)func NewCloudBackupCollectionRestoreJob(ctx *Context, name string, args CloudBackupCollectionRestoreJobArgs, opts ...ResourceOption) (*CloudBackupCollectionRestoreJob, error)public CloudBackupCollectionRestoreJob(string name, CloudBackupCollectionRestoreJobArgs args, CustomResourceOptions? opts = null)
public CloudBackupCollectionRestoreJob(String name, CloudBackupCollectionRestoreJobArgs args)
public CloudBackupCollectionRestoreJob(String name, CloudBackupCollectionRestoreJobArgs args, CustomResourceOptions options)
type: mongodbatlas:CloudBackupCollectionRestoreJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "mongodbatlas_cloud_backup_collection_restore_job" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CloudBackupCollectionRestoreJobArgs
- 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 CloudBackupCollectionRestoreJobArgs
- 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 CloudBackupCollectionRestoreJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudBackupCollectionRestoreJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CloudBackupCollectionRestoreJobArgs
- 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.
var cloudBackupCollectionRestoreJobResource = new Mongodbatlas.CloudBackupCollectionRestoreJob("cloudBackupCollectionRestoreJobResource", new()
{
ProjectId = "string",
WriteStrategy = "string",
TargetProjectId = "string",
ClusterName = "string",
TargetClusterName = "string",
IndexStrategy = "string",
DatabaseSuffix = "string",
OplogTs = 0,
PointInTimeUtcSeconds = 0,
OplogInc = 0,
SnapshotId = "string",
Databases = new[]
{
new Mongodbatlas.Inputs.CloudBackupCollectionRestoreJobDatabaseArgs
{
SourceNamespace = "string",
TargetNamespace = "string",
},
},
Collections = new[]
{
new Mongodbatlas.Inputs.CloudBackupCollectionRestoreJobCollectionArgs
{
SourceNamespace = "string",
TargetNamespace = "string",
},
},
Timeouts = new Mongodbatlas.Inputs.CloudBackupCollectionRestoreJobTimeoutsArgs
{
Create = "string",
},
CollectionSuffix = "string",
});
example, err := mongodbatlas.NewCloudBackupCollectionRestoreJob(ctx, "cloudBackupCollectionRestoreJobResource", &mongodbatlas.CloudBackupCollectionRestoreJobArgs{
ProjectId: pulumi.String("string"),
WriteStrategy: pulumi.String("string"),
TargetProjectId: pulumi.String("string"),
ClusterName: pulumi.String("string"),
TargetClusterName: pulumi.String("string"),
IndexStrategy: pulumi.String("string"),
DatabaseSuffix: pulumi.String("string"),
OplogTs: pulumi.Int(0),
PointInTimeUtcSeconds: pulumi.Int(0),
OplogInc: pulumi.Int(0),
SnapshotId: pulumi.String("string"),
Databases: mongodbatlas.CloudBackupCollectionRestoreJobDatabaseArray{
&mongodbatlas.CloudBackupCollectionRestoreJobDatabaseArgs{
SourceNamespace: pulumi.String("string"),
TargetNamespace: pulumi.String("string"),
},
},
Collections: mongodbatlas.CloudBackupCollectionRestoreJobCollectionArray{
&mongodbatlas.CloudBackupCollectionRestoreJobCollectionArgs{
SourceNamespace: pulumi.String("string"),
TargetNamespace: pulumi.String("string"),
},
},
Timeouts: &mongodbatlas.CloudBackupCollectionRestoreJobTimeoutsArgs{
Create: pulumi.String("string"),
},
CollectionSuffix: pulumi.String("string"),
})
resource "mongodbatlas_cloud_backup_collection_restore_job" "cloudBackupCollectionRestoreJobResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
write_strategy = "string"
target_project_id = "string"
cluster_name = "string"
target_cluster_name = "string"
index_strategy = "string"
database_suffix = "string"
oplog_ts = 0
point_in_time_utc_seconds = 0
oplog_inc = 0
snapshot_id = "string"
databases {
source_namespace = "string"
target_namespace = "string"
}
collections {
source_namespace = "string"
target_namespace = "string"
}
timeouts = {
create = "string"
}
collection_suffix = "string"
}
var cloudBackupCollectionRestoreJobResource = new CloudBackupCollectionRestoreJob("cloudBackupCollectionRestoreJobResource", CloudBackupCollectionRestoreJobArgs.builder()
.projectId("string")
.writeStrategy("string")
.targetProjectId("string")
.clusterName("string")
.targetClusterName("string")
.indexStrategy("string")
.databaseSuffix("string")
.oplogTs(0)
.pointInTimeUtcSeconds(0)
.oplogInc(0)
.snapshotId("string")
.databases(CloudBackupCollectionRestoreJobDatabaseArgs.builder()
.sourceNamespace("string")
.targetNamespace("string")
.build())
.collections(CloudBackupCollectionRestoreJobCollectionArgs.builder()
.sourceNamespace("string")
.targetNamespace("string")
.build())
.timeouts(CloudBackupCollectionRestoreJobTimeoutsArgs.builder()
.create("string")
.build())
.collectionSuffix("string")
.build());
cloud_backup_collection_restore_job_resource = mongodbatlas.CloudBackupCollectionRestoreJob("cloudBackupCollectionRestoreJobResource",
project_id="string",
write_strategy="string",
target_project_id="string",
cluster_name="string",
target_cluster_name="string",
index_strategy="string",
database_suffix="string",
oplog_ts=0,
point_in_time_utc_seconds=0,
oplog_inc=0,
snapshot_id="string",
databases=[{
"source_namespace": "string",
"target_namespace": "string",
}],
collections=[{
"source_namespace": "string",
"target_namespace": "string",
}],
timeouts={
"create": "string",
},
collection_suffix="string")
const cloudBackupCollectionRestoreJobResource = new mongodbatlas.CloudBackupCollectionRestoreJob("cloudBackupCollectionRestoreJobResource", {
projectId: "string",
writeStrategy: "string",
targetProjectId: "string",
clusterName: "string",
targetClusterName: "string",
indexStrategy: "string",
databaseSuffix: "string",
oplogTs: 0,
pointInTimeUtcSeconds: 0,
oplogInc: 0,
snapshotId: "string",
databases: [{
sourceNamespace: "string",
targetNamespace: "string",
}],
collections: [{
sourceNamespace: "string",
targetNamespace: "string",
}],
timeouts: {
create: "string",
},
collectionSuffix: "string",
});
type: mongodbatlas:CloudBackupCollectionRestoreJob
properties:
clusterName: string
collectionSuffix: string
collections:
- sourceNamespace: string
targetNamespace: string
databaseSuffix: string
databases:
- sourceNamespace: string
targetNamespace: string
indexStrategy: string
oplogInc: 0
oplogTs: 0
pointInTimeUtcSeconds: 0
projectId: string
snapshotId: string
targetClusterName: string
targetProjectId: string
timeouts:
create: string
writeStrategy: string
CloudBackupCollectionRestoreJob 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 CloudBackupCollectionRestoreJob resource accepts the following input properties:
- Cluster
Name string - Human-readable label that identifies the source cluster for the restore.
- Index
Strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Target
Cluster stringName - Target cluster name.
- Target
Project stringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Write
Strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - Collection
Suffix string - Optional suffix applied to restored collection names.
- Collections
List<Cloud
Backup Collection Restore Job Collection> - List of collections to restore (up to 100 items).
- Database
Suffix string - Optional suffix applied to restored database names.
- Databases
List<Cloud
Backup Collection Restore Job Database> - List of databases to restore (up to 100 items).
- Oplog
Inc int - Oplog increment for point-in-time restore.
- Oplog
Ts int - Oplog timestamp (seconds part) for point-in-time restore.
- Point
In intTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- Snapshot
Id string - ID of the snapshot to restore.
- Timeouts
Cloud
Backup Collection Restore Job Timeouts
- Cluster
Name string - Human-readable label that identifies the source cluster for the restore.
- Index
Strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Target
Cluster stringName - Target cluster name.
- Target
Project stringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Write
Strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - Collection
Suffix string - Optional suffix applied to restored collection names.
- Collections
[]Cloud
Backup Collection Restore Job Collection Args - List of collections to restore (up to 100 items).
- Database
Suffix string - Optional suffix applied to restored database names.
- Databases
[]Cloud
Backup Collection Restore Job Database Args - List of databases to restore (up to 100 items).
- Oplog
Inc int - Oplog increment for point-in-time restore.
- Oplog
Ts int - Oplog timestamp (seconds part) for point-in-time restore.
- Point
In intTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- Snapshot
Id string - ID of the snapshot to restore.
- Timeouts
Cloud
Backup Collection Restore Job Timeouts Args
- cluster_
name string - Human-readable label that identifies the source cluster for the restore.
- index_
strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- project_
id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - target_
cluster_ stringname - Target cluster name.
- target_
project_ stringid - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - write_
strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - collection_
suffix string - Optional suffix applied to restored collection names.
- collections list(object)
- List of collections to restore (up to 100 items).
- database_
suffix string - Optional suffix applied to restored database names.
- databases list(object)
- List of databases to restore (up to 100 items).
- oplog_
inc number - Oplog increment for point-in-time restore.
- oplog_
ts number - Oplog timestamp (seconds part) for point-in-time restore.
- point_
in_ numbertime_ utc_ seconds - Point-in-time restore time in seconds since UNIX epoch.
- snapshot_
id string - ID of the snapshot to restore.
- timeouts object
- cluster
Name String - Human-readable label that identifies the source cluster for the restore.
- index
Strategy String - Strategy for restoring indexes (all, none, or all except TTL).
- project
Id String - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - target
Cluster StringName - Target cluster name.
- target
Project StringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - write
Strategy String - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - collection
Suffix String - Optional suffix applied to restored collection names.
- collections
List<Cloud
Backup Collection Restore Job Collection> - List of collections to restore (up to 100 items).
- database
Suffix String - Optional suffix applied to restored database names.
- databases
List<Cloud
Backup Collection Restore Job Database> - List of databases to restore (up to 100 items).
- oplog
Inc Integer - Oplog increment for point-in-time restore.
- oplog
Ts Integer - Oplog timestamp (seconds part) for point-in-time restore.
- point
In IntegerTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- snapshot
Id String - ID of the snapshot to restore.
- timeouts
Cloud
Backup Collection Restore Job Timeouts
- cluster
Name string - Human-readable label that identifies the source cluster for the restore.
- index
Strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- project
Id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - target
Cluster stringName - Target cluster name.
- target
Project stringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - write
Strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - collection
Suffix string - Optional suffix applied to restored collection names.
- collections
Cloud
Backup Collection Restore Job Collection[] - List of collections to restore (up to 100 items).
- database
Suffix string - Optional suffix applied to restored database names.
- databases
Cloud
Backup Collection Restore Job Database[] - List of databases to restore (up to 100 items).
- oplog
Inc number - Oplog increment for point-in-time restore.
- oplog
Ts number - Oplog timestamp (seconds part) for point-in-time restore.
- point
In numberTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- snapshot
Id string - ID of the snapshot to restore.
- timeouts
Cloud
Backup Collection Restore Job Timeouts
- cluster_
name str - Human-readable label that identifies the source cluster for the restore.
- index_
strategy str - Strategy for restoring indexes (all, none, or all except TTL).
- project_
id str - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - target_
cluster_ strname - Target cluster name.
- target_
project_ strid - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - write_
strategy str - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - collection_
suffix str - Optional suffix applied to restored collection names.
- collections
Sequence[Cloud
Backup Collection Restore Job Collection Args] - List of collections to restore (up to 100 items).
- database_
suffix str - Optional suffix applied to restored database names.
- databases
Sequence[Cloud
Backup Collection Restore Job Database Args] - List of databases to restore (up to 100 items).
- oplog_
inc int - Oplog increment for point-in-time restore.
- oplog_
ts int - Oplog timestamp (seconds part) for point-in-time restore.
- point_
in_ inttime_ utc_ seconds - Point-in-time restore time in seconds since UNIX epoch.
- snapshot_
id str - ID of the snapshot to restore.
- timeouts
Cloud
Backup Collection Restore Job Timeouts Args
- cluster
Name String - Human-readable label that identifies the source cluster for the restore.
- index
Strategy String - Strategy for restoring indexes (all, none, or all except TTL).
- project
Id String - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - target
Cluster StringName - Target cluster name.
- target
Project StringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - write
Strategy String - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore. - collection
Suffix String - Optional suffix applied to restored collection names.
- collections List<Property Map>
- List of collections to restore (up to 100 items).
- database
Suffix String - Optional suffix applied to restored database names.
- databases List<Property Map>
- List of databases to restore (up to 100 items).
- oplog
Inc Number - Oplog increment for point-in-time restore.
- oplog
Ts Number - Oplog timestamp (seconds part) for point-in-time restore.
- point
In NumberTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- snapshot
Id String - ID of the snapshot to restore.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudBackupCollectionRestoreJob resource produces the following output properties:
- Created
At string - Date and time when the restore job was created (ISO 8601 format in UTC).
- Error
Message string - Error message when the job has failed or been canceled.
- Finished
At string - Date and time when the restore job finished (ISO 8601 format in UTC).
- Id string
- The provider-assigned unique ID for this managed resource.
- Index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- Job
Id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- Restored
Documents int - Number of documents restored so far across all supported collections.
- State string
- Current state of the collection restore job.
- Total
Documents int - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- Created
At string - Date and time when the restore job was created (ISO 8601 format in UTC).
- Error
Message string - Error message when the job has failed or been canceled.
- Finished
At string - Date and time when the restore job finished (ISO 8601 format in UTC).
- Id string
- The provider-assigned unique ID for this managed resource.
- Index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- Job
Id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- Restored
Documents int - Number of documents restored so far across all supported collections.
- State string
- Current state of the collection restore job.
- Total
Documents int - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- created_
at string - Date and time when the restore job was created (ISO 8601 format in UTC).
- error_
message string - Error message when the job has failed or been canceled.
- finished_
at string - Date and time when the restore job finished (ISO 8601 format in UTC).
- id string
- The provider-assigned unique ID for this managed resource.
- index_
status object - Overall index build status for a collection restore job.
- job_
id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- restored_
documents number - Number of documents restored so far across all supported collections.
- state string
- Current state of the collection restore job.
- total_
documents number - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- created
At String - Date and time when the restore job was created (ISO 8601 format in UTC).
- error
Message String - Error message when the job has failed or been canceled.
- finished
At String - Date and time when the restore job finished (ISO 8601 format in UTC).
- id String
- The provider-assigned unique ID for this managed resource.
- index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- job
Id String - Unique 24-hexadecimal digit string that identifies the collection restore job.
- restored
Documents Integer - Number of documents restored so far across all supported collections.
- state String
- Current state of the collection restore job.
- total
Documents Integer - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- created
At string - Date and time when the restore job was created (ISO 8601 format in UTC).
- error
Message string - Error message when the job has failed or been canceled.
- finished
At string - Date and time when the restore job finished (ISO 8601 format in UTC).
- id string
- The provider-assigned unique ID for this managed resource.
- index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- job
Id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- restored
Documents number - Number of documents restored so far across all supported collections.
- state string
- Current state of the collection restore job.
- total
Documents number - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- created_
at str - Date and time when the restore job was created (ISO 8601 format in UTC).
- error_
message str - Error message when the job has failed or been canceled.
- finished_
at str - Date and time when the restore job finished (ISO 8601 format in UTC).
- id str
- The provider-assigned unique ID for this managed resource.
- index_
status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- job_
id str - Unique 24-hexadecimal digit string that identifies the collection restore job.
- restored_
documents int - Number of documents restored so far across all supported collections.
- state str
- Current state of the collection restore job.
- total_
documents int - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- created
At String - Date and time when the restore job was created (ISO 8601 format in UTC).
- error
Message String - Error message when the job has failed or been canceled.
- finished
At String - Date and time when the restore job finished (ISO 8601 format in UTC).
- id String
- The provider-assigned unique ID for this managed resource.
- index
Status Property Map - Overall index build status for a collection restore job.
- job
Id String - Unique 24-hexadecimal digit string that identifies the collection restore job.
- restored
Documents Number - Number of documents restored so far across all supported collections.
- state String
- Current state of the collection restore job.
- total
Documents Number - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
Look up Existing CloudBackupCollectionRestoreJob Resource
Get an existing CloudBackupCollectionRestoreJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CloudBackupCollectionRestoreJobState, opts?: CustomResourceOptions): CloudBackupCollectionRestoreJob@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
collection_suffix: Optional[str] = None,
collections: Optional[Sequence[CloudBackupCollectionRestoreJobCollectionArgs]] = None,
created_at: Optional[str] = None,
database_suffix: Optional[str] = None,
databases: Optional[Sequence[CloudBackupCollectionRestoreJobDatabaseArgs]] = None,
error_message: Optional[str] = None,
finished_at: Optional[str] = None,
index_status: Optional[CloudBackupCollectionRestoreJobIndexStatusArgs] = None,
index_strategy: Optional[str] = None,
job_id: Optional[str] = None,
oplog_inc: Optional[int] = None,
oplog_ts: Optional[int] = None,
point_in_time_utc_seconds: Optional[int] = None,
project_id: Optional[str] = None,
restored_documents: Optional[int] = None,
snapshot_id: Optional[str] = None,
state: Optional[str] = None,
target_cluster_name: Optional[str] = None,
target_project_id: Optional[str] = None,
timeouts: Optional[CloudBackupCollectionRestoreJobTimeoutsArgs] = None,
total_documents: Optional[int] = None,
write_strategy: Optional[str] = None) -> CloudBackupCollectionRestoreJobfunc GetCloudBackupCollectionRestoreJob(ctx *Context, name string, id IDInput, state *CloudBackupCollectionRestoreJobState, opts ...ResourceOption) (*CloudBackupCollectionRestoreJob, error)public static CloudBackupCollectionRestoreJob Get(string name, Input<string> id, CloudBackupCollectionRestoreJobState? state, CustomResourceOptions? opts = null)public static CloudBackupCollectionRestoreJob get(String name, Output<String> id, CloudBackupCollectionRestoreJobState state, CustomResourceOptions options)resources: _: type: mongodbatlas:CloudBackupCollectionRestoreJob get: id: ${id}import {
to = mongodbatlas_cloud_backup_collection_restore_job.example
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.
- Cluster
Name string - Human-readable label that identifies the source cluster for the restore.
- Collection
Suffix string - Optional suffix applied to restored collection names.
- Collections
List<Cloud
Backup Collection Restore Job Collection> - List of collections to restore (up to 100 items).
- Created
At string - Date and time when the restore job was created (ISO 8601 format in UTC).
- Database
Suffix string - Optional suffix applied to restored database names.
- Databases
List<Cloud
Backup Collection Restore Job Database> - List of databases to restore (up to 100 items).
- Error
Message string - Error message when the job has failed or been canceled.
- Finished
At string - Date and time when the restore job finished (ISO 8601 format in UTC).
- Index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- Index
Strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- Job
Id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- Oplog
Inc int - Oplog increment for point-in-time restore.
- Oplog
Ts int - Oplog timestamp (seconds part) for point-in-time restore.
- Point
In intTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Restored
Documents int - Number of documents restored so far across all supported collections.
- Snapshot
Id string - ID of the snapshot to restore.
- State string
- Current state of the collection restore job.
- Target
Cluster stringName - Target cluster name.
- Target
Project stringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Timeouts
Cloud
Backup Collection Restore Job Timeouts - Total
Documents int - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- Write
Strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
- Cluster
Name string - Human-readable label that identifies the source cluster for the restore.
- Collection
Suffix string - Optional suffix applied to restored collection names.
- Collections
[]Cloud
Backup Collection Restore Job Collection Args - List of collections to restore (up to 100 items).
- Created
At string - Date and time when the restore job was created (ISO 8601 format in UTC).
- Database
Suffix string - Optional suffix applied to restored database names.
- Databases
[]Cloud
Backup Collection Restore Job Database Args - List of databases to restore (up to 100 items).
- Error
Message string - Error message when the job has failed or been canceled.
- Finished
At string - Date and time when the restore job finished (ISO 8601 format in UTC).
- Index
Status CloudBackup Collection Restore Job Index Status Args - Overall index build status for a collection restore job.
- Index
Strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- Job
Id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- Oplog
Inc int - Oplog increment for point-in-time restore.
- Oplog
Ts int - Oplog timestamp (seconds part) for point-in-time restore.
- Point
In intTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Restored
Documents int - Number of documents restored so far across all supported collections.
- Snapshot
Id string - ID of the snapshot to restore.
- State string
- Current state of the collection restore job.
- Target
Cluster stringName - Target cluster name.
- Target
Project stringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - Timeouts
Cloud
Backup Collection Restore Job Timeouts Args - Total
Documents int - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- Write
Strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
- cluster_
name string - Human-readable label that identifies the source cluster for the restore.
- collection_
suffix string - Optional suffix applied to restored collection names.
- collections list(object)
- List of collections to restore (up to 100 items).
- created_
at string - Date and time when the restore job was created (ISO 8601 format in UTC).
- database_
suffix string - Optional suffix applied to restored database names.
- databases list(object)
- List of databases to restore (up to 100 items).
- error_
message string - Error message when the job has failed or been canceled.
- finished_
at string - Date and time when the restore job finished (ISO 8601 format in UTC).
- index_
status object - Overall index build status for a collection restore job.
- index_
strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- job_
id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- oplog_
inc number - Oplog increment for point-in-time restore.
- oplog_
ts number - Oplog timestamp (seconds part) for point-in-time restore.
- point_
in_ numbertime_ utc_ seconds - Point-in-time restore time in seconds since UNIX epoch.
- project_
id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - restored_
documents number - Number of documents restored so far across all supported collections.
- snapshot_
id string - ID of the snapshot to restore.
- state string
- Current state of the collection restore job.
- target_
cluster_ stringname - Target cluster name.
- target_
project_ stringid - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - timeouts object
- total_
documents number - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- write_
strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
- cluster
Name String - Human-readable label that identifies the source cluster for the restore.
- collection
Suffix String - Optional suffix applied to restored collection names.
- collections
List<Cloud
Backup Collection Restore Job Collection> - List of collections to restore (up to 100 items).
- created
At String - Date and time when the restore job was created (ISO 8601 format in UTC).
- database
Suffix String - Optional suffix applied to restored database names.
- databases
List<Cloud
Backup Collection Restore Job Database> - List of databases to restore (up to 100 items).
- error
Message String - Error message when the job has failed or been canceled.
- finished
At String - Date and time when the restore job finished (ISO 8601 format in UTC).
- index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- index
Strategy String - Strategy for restoring indexes (all, none, or all except TTL).
- job
Id String - Unique 24-hexadecimal digit string that identifies the collection restore job.
- oplog
Inc Integer - Oplog increment for point-in-time restore.
- oplog
Ts Integer - Oplog timestamp (seconds part) for point-in-time restore.
- point
In IntegerTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - restored
Documents Integer - Number of documents restored so far across all supported collections.
- snapshot
Id String - ID of the snapshot to restore.
- state String
- Current state of the collection restore job.
- target
Cluster StringName - Target cluster name.
- target
Project StringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - timeouts
Cloud
Backup Collection Restore Job Timeouts - total
Documents Integer - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- write
Strategy String - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
- cluster
Name string - Human-readable label that identifies the source cluster for the restore.
- collection
Suffix string - Optional suffix applied to restored collection names.
- collections
Cloud
Backup Collection Restore Job Collection[] - List of collections to restore (up to 100 items).
- created
At string - Date and time when the restore job was created (ISO 8601 format in UTC).
- database
Suffix string - Optional suffix applied to restored database names.
- databases
Cloud
Backup Collection Restore Job Database[] - List of databases to restore (up to 100 items).
- error
Message string - Error message when the job has failed or been canceled.
- finished
At string - Date and time when the restore job finished (ISO 8601 format in UTC).
- index
Status CloudBackup Collection Restore Job Index Status - Overall index build status for a collection restore job.
- index
Strategy string - Strategy for restoring indexes (all, none, or all except TTL).
- job
Id string - Unique 24-hexadecimal digit string that identifies the collection restore job.
- oplog
Inc number - Oplog increment for point-in-time restore.
- oplog
Ts number - Oplog timestamp (seconds part) for point-in-time restore.
- point
In numberTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- project
Id string - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - restored
Documents number - Number of documents restored so far across all supported collections.
- snapshot
Id string - ID of the snapshot to restore.
- state string
- Current state of the collection restore job.
- target
Cluster stringName - Target cluster name.
- target
Project stringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - timeouts
Cloud
Backup Collection Restore Job Timeouts - total
Documents number - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- write
Strategy string - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
- cluster_
name str - Human-readable label that identifies the source cluster for the restore.
- collection_
suffix str - Optional suffix applied to restored collection names.
- collections
Sequence[Cloud
Backup Collection Restore Job Collection Args] - List of collections to restore (up to 100 items).
- created_
at str - Date and time when the restore job was created (ISO 8601 format in UTC).
- database_
suffix str - Optional suffix applied to restored database names.
- databases
Sequence[Cloud
Backup Collection Restore Job Database Args] - List of databases to restore (up to 100 items).
- error_
message str - Error message when the job has failed or been canceled.
- finished_
at str - Date and time when the restore job finished (ISO 8601 format in UTC).
- index_
status CloudBackup Collection Restore Job Index Status Args - Overall index build status for a collection restore job.
- index_
strategy str - Strategy for restoring indexes (all, none, or all except TTL).
- job_
id str - Unique 24-hexadecimal digit string that identifies the collection restore job.
- oplog_
inc int - Oplog increment for point-in-time restore.
- oplog_
ts int - Oplog timestamp (seconds part) for point-in-time restore.
- point_
in_ inttime_ utc_ seconds - Point-in-time restore time in seconds since UNIX epoch.
- project_
id str - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - restored_
documents int - Number of documents restored so far across all supported collections.
- snapshot_
id str - ID of the snapshot to restore.
- state str
- Current state of the collection restore job.
- target_
cluster_ strname - Target cluster name.
- target_
project_ strid - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - timeouts
Cloud
Backup Collection Restore Job Timeouts Args - total_
documents int - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- write_
strategy str - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
- cluster
Name String - Human-readable label that identifies the source cluster for the restore.
- collection
Suffix String - Optional suffix applied to restored collection names.
- collections List<Property Map>
- List of collections to restore (up to 100 items).
- created
At String - Date and time when the restore job was created (ISO 8601 format in UTC).
- database
Suffix String - Optional suffix applied to restored database names.
- databases List<Property Map>
- List of databases to restore (up to 100 items).
- error
Message String - Error message when the job has failed or been canceled.
- finished
At String - Date and time when the restore job finished (ISO 8601 format in UTC).
- index
Status Property Map - Overall index build status for a collection restore job.
- index
Strategy String - Strategy for restoring indexes (all, none, or all except TTL).
- job
Id String - Unique 24-hexadecimal digit string that identifies the collection restore job.
- oplog
Inc Number - Oplog increment for point-in-time restore.
- oplog
Ts Number - Oplog timestamp (seconds part) for point-in-time restore.
- point
In NumberTime Utc Seconds - Point-in-time restore time in seconds since UNIX epoch.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - restored
Documents Number - Number of documents restored so far across all supported collections.
- snapshot
Id String - ID of the snapshot to restore.
- state String
- Current state of the collection restore job.
- target
Cluster StringName - Target cluster name.
- target
Project StringId - Unique 24-hexadecimal digit string that identifies your project, also known as
groupIdin the official documentation. - timeouts Property Map
- total
Documents Number - Total number of documents across all supported collections in the restore job. This value may initially reflect an estimate based on collection metadata and can change as accurate document counts become available during the restore.
- write
Strategy String - Strategy for writing data on the target (create as new or overwrite existing). With
OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.
Supporting Types
CloudBackupCollectionRestoreJobCollection, CloudBackupCollectionRestoreJobCollectionArgs
- Source
Namespace string - Collection requested to restore, as
database.collection. - Target
Namespace string - Requested target collection as
database.collection; if empty, source namespace is used.
- Source
Namespace string - Collection requested to restore, as
database.collection. - Target
Namespace string - Requested target collection as
database.collection; if empty, source namespace is used.
- source_
namespace string - Collection requested to restore, as
database.collection. - target_
namespace string - Requested target collection as
database.collection; if empty, source namespace is used.
- source
Namespace String - Collection requested to restore, as
database.collection. - target
Namespace String - Requested target collection as
database.collection; if empty, source namespace is used.
- source
Namespace string - Collection requested to restore, as
database.collection. - target
Namespace string - Requested target collection as
database.collection; if empty, source namespace is used.
- source_
namespace str - Collection requested to restore, as
database.collection. - target_
namespace str - Requested target collection as
database.collection; if empty, source namespace is used.
- source
Namespace String - Collection requested to restore, as
database.collection. - target
Namespace String - Requested target collection as
database.collection; if empty, source namespace is used.
CloudBackupCollectionRestoreJobDatabase, CloudBackupCollectionRestoreJobDatabaseArgs
- Source
Namespace string - Database name requested to restore.
- Target
Namespace string - Requested target database name; if empty, source database name is used.
- Source
Namespace string - Database name requested to restore.
- Target
Namespace string - Requested target database name; if empty, source database name is used.
- source_
namespace string - Database name requested to restore.
- target_
namespace string - Requested target database name; if empty, source database name is used.
- source
Namespace String - Database name requested to restore.
- target
Namespace String - Requested target database name; if empty, source database name is used.
- source
Namespace string - Database name requested to restore.
- target
Namespace string - Requested target database name; if empty, source database name is used.
- source_
namespace str - Database name requested to restore.
- target_
namespace str - Requested target database name; if empty, source database name is used.
- source
Namespace String - Database name requested to restore.
- target
Namespace String - Requested target database name; if empty, source database name is used.
CloudBackupCollectionRestoreJobIndexStatus, CloudBackupCollectionRestoreJobIndexStatusArgs
- Failed
Collection intCount - Number of collections that failed to build indexes.
- State string
- Index build state indicating the status of index creation during or after a restore operation.
- Failed
Collection intCount - Number of collections that failed to build indexes.
- State string
- Index build state indicating the status of index creation during or after a restore operation.
- failed_
collection_ numbercount - Number of collections that failed to build indexes.
- state string
- Index build state indicating the status of index creation during or after a restore operation.
- failed
Collection IntegerCount - Number of collections that failed to build indexes.
- state String
- Index build state indicating the status of index creation during or after a restore operation.
- failed
Collection numberCount - Number of collections that failed to build indexes.
- state string
- Index build state indicating the status of index creation during or after a restore operation.
- failed_
collection_ intcount - Number of collections that failed to build indexes.
- state str
- Index build state indicating the status of index creation during or after a restore operation.
- failed
Collection NumberCount - Number of collections that failed to build indexes.
- state String
- Index build state indicating the status of index creation during or after a restore operation.
CloudBackupCollectionRestoreJobTimeouts, CloudBackupCollectionRestoreJobTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
Collection restore job resource can be imported using the source project ID, source cluster name, and job ID, separated by slashes, for example:
$ pulumi import mongodbatlas:index/cloudBackupCollectionRestoreJob:CloudBackupCollectionRestoreJob this 650972848269185c55f40ca1/MyCluster/6789abcd1234ef5678901234
Import hydrates the current GET state. It does not wait for a running job to finish.
For more information see: MongoDB Atlas - Restore from Selected Databases and Collections Documentation.
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
mongodbatlasTerraform Provider.
published on Friday, Aug 28, 2026 by Pulumi