getCloudProviderSnapshotRestoreJob

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

Using getCloudProviderSnapshotRestoreJob

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

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

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

The following arguments are supported:

ClusterName string
The name of the Atlas cluster for which you want to retrieve the restore job.
JobId string
The unique identifier of the restore job to retrieve.
ProjectId string
The unique identifier of the project for the Atlas cluster.
ClusterName string
The name of the Atlas cluster for which you want to retrieve the restore job.
JobId string
The unique identifier of the restore job to retrieve.
ProjectId string
The unique identifier of the project for the Atlas cluster.
clusterName string
The name of the Atlas cluster for which you want to retrieve the restore job.
jobId string
The unique identifier of the restore job to retrieve.
projectId string
The unique identifier of the project for the Atlas cluster.
cluster_name str
The name of the Atlas cluster for which you want to retrieve the restore job.
job_id str
The unique identifier of the restore job to retrieve.
project_id str
The unique identifier of the project for the Atlas cluster.

getCloudProviderSnapshotRestoreJob Result

The following output properties are available:

Cancelled bool
Indicates whether the restore job was canceled.
ClusterName string
CreatedAt string
UTC ISO 8601 formatted point in time when Atlas created the restore job.
DeliveryType string
Type of restore job to create. Possible values are: automated and download.
DeliveryUrls List<string>
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
Expired bool
Indicates whether the restore job expired.
ExpiresAt string
UTC ISO 8601 formatted point in time when the restore job expires.
FinishedAt string
UTC ISO 8601 formatted point in time when the restore job completed.
Id string
The provider-assigned unique ID for this managed resource.
JobId string
OplogInc int
OplogTs int
PointInTimeUtcSeconds int
ProjectId string
SnapshotId string
Unique identifier of the source snapshot ID of the restore job.
TargetClusterName string
Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
TargetProjectId string
Timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
Cancelled bool
Indicates whether the restore job was canceled.
ClusterName string
CreatedAt string
UTC ISO 8601 formatted point in time when Atlas created the restore job.
DeliveryType string
Type of restore job to create. Possible values are: automated and download.
DeliveryUrls []string
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
Expired bool
Indicates whether the restore job expired.
ExpiresAt string
UTC ISO 8601 formatted point in time when the restore job expires.
FinishedAt string
UTC ISO 8601 formatted point in time when the restore job completed.
Id string
The provider-assigned unique ID for this managed resource.
JobId string
OplogInc int
OplogTs int
PointInTimeUtcSeconds int
ProjectId string
SnapshotId string
Unique identifier of the source snapshot ID of the restore job.
TargetClusterName string
Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
TargetProjectId string
Timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
cancelled boolean
Indicates whether the restore job was canceled.
clusterName string
createdAt string
UTC ISO 8601 formatted point in time when Atlas created the restore job.
deliveryType string
Type of restore job to create. Possible values are: automated and download.
deliveryUrls string[]
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired boolean
Indicates whether the restore job expired.
expiresAt string
UTC ISO 8601 formatted point in time when the restore job expires.
finishedAt string
UTC ISO 8601 formatted point in time when the restore job completed.
id string
The provider-assigned unique ID for this managed resource.
jobId string
oplogInc number
oplogTs number
pointInTimeUtcSeconds number
projectId string
snapshotId string
Unique identifier of the source snapshot ID of the restore job.
targetClusterName string
Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
targetProjectId string
timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
cancelled bool
Indicates whether the restore job was canceled.
cluster_name str
created_at str
UTC ISO 8601 formatted point in time when Atlas created the restore job.
delivery_type str
Type of restore job to create. Possible values are: automated and download.
delivery_urls Sequence[str]
One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired bool
Indicates whether the restore job expired.
expires_at str
UTC ISO 8601 formatted point in time when the restore job expires.
finished_at str
UTC ISO 8601 formatted point in time when the restore job completed.
id str
The provider-assigned unique ID for this managed resource.
job_id str
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.
target_cluster_name str
Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
target_project_id str
timestamp str
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

Package Details

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