mongodbatlas.CloudBackupSnapshotRestoreJob
Explore with Pulumi AI
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 seeMongoDB Atlas API Reference.
Create CloudBackupSnapshotRestoreJob Resource
new CloudBackupSnapshotRestoreJob(name: string, args: CloudBackupSnapshotRestoreJobArgs, opts?: CustomResourceOptions);
@overload
def CloudBackupSnapshotRestoreJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
delivery_type: Optional[Mapping[str, str]] = None,
delivery_type_config: Optional[CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs] = None,
project_id: Optional[str] = None,
snapshot_id: Optional[str] = None)
@overload
def CloudBackupSnapshotRestoreJob(resource_name: str,
args: CloudBackupSnapshotRestoreJobArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The CloudBackupSnapshotRestoreJob resource accepts the following input properties:
- Cluster
Name string The name of the Atlas cluster whose snapshot you want to restore.
- Project
Id string The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- Snapshot
Id string Unique identifier of the snapshot to restore.
- Delivery
Type Dictionary<string, string> this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- Delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
- Cluster
Name string The name of the Atlas cluster whose snapshot you want to restore.
- Project
Id string The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- Snapshot
Id string Unique identifier of the snapshot to restore.
- Delivery
Type map[string]string this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- Delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config Args 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
- cluster
Name String The name of the Atlas cluster whose snapshot you want to restore.
- project
Id String The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot
Id String Unique identifier of the snapshot to restore.
- delivery
Type Map<String,String> this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
- cluster
Name string The name of the Atlas cluster whose snapshot you want to restore.
- project
Id string The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot
Id string Unique identifier of the snapshot to restore.
- delivery
Type {[key: string]: string} this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
- cluster_
name str The name of the Atlas cluster whose snapshot you want to restore.
- project_
id str The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot_
id str Unique identifier of the snapshot to restore.
- delivery_
type Mapping[str, str] this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery_
type_ Cloudconfig Backup Snapshot Restore Job Delivery Type Config Args 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
- cluster
Name String The name of the Atlas cluster whose snapshot you want to restore.
- project
Id String The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot
Id String Unique identifier of the snapshot to restore.
- delivery
Type Map<String> this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery
Type Property MapConfig 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
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.
- Created
At string UTC ISO 8601 formatted point in time when Atlas created the restore job.
- Delivery
Urls 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.
- Expires
At string UTC ISO 8601 formatted point in time when the restore job expires.
- Finished
At string UTC ISO 8601 formatted point in time when the restore job completed.
- Id string
The provider-assigned unique ID for this managed resource.
- Snapshot
Restore stringJob Id The unique identifier of the restore job.
- Timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- Cancelled bool
Indicates whether the restore job was canceled.
- Created
At string UTC ISO 8601 formatted point in time when Atlas created the restore job.
- Delivery
Urls []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.
- Expires
At string UTC ISO 8601 formatted point in time when the restore job expires.
- Finished
At string UTC ISO 8601 formatted point in time when the restore job completed.
- Id string
The provider-assigned unique ID for this managed resource.
- Snapshot
Restore stringJob Id The unique identifier of the restore job.
- Timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled Boolean
Indicates whether the restore job was canceled.
- created
At String UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery
Urls 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.
- expires
At String UTC ISO 8601 formatted point in time when the restore job expires.
- finished
At String UTC ISO 8601 formatted point in time when the restore job completed.
- id String
The provider-assigned unique ID for this managed resource.
- snapshot
Restore StringJob Id The unique identifier of the restore job.
- timestamp String
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled boolean
Indicates whether the restore job was canceled.
- created
At string UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery
Urls 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.
- expires
At string UTC ISO 8601 formatted point in time when the restore job expires.
- finished
At string UTC ISO 8601 formatted point in time when the restore job completed.
- id string
The provider-assigned unique ID for this managed resource.
- snapshot
Restore stringJob Id The unique identifier of the restore job.
- timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled bool
Indicates whether the restore job was canceled.
- created_
at str UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery_
urls Sequence[str] One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
- expired bool
Indicates whether the restore job expired.
- expires_
at str UTC ISO 8601 formatted point in time when the restore job expires.
- finished_
at str UTC ISO 8601 formatted point in time when the restore job completed.
- id str
The provider-assigned unique ID for this managed resource.
- snapshot_
restore_ strjob_ id The unique identifier of the restore job.
- timestamp str
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled Boolean
Indicates whether the restore job was canceled.
- created
At String UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery
Urls 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.
- expires
At String UTC ISO 8601 formatted point in time when the restore job expires.
- finished
At String UTC ISO 8601 formatted point in time when the restore job completed.
- id String
The provider-assigned unique ID for this managed resource.
- snapshot
Restore StringJob Id The unique identifier of the restore job.
- timestamp String
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
Look up Existing CloudBackupSnapshotRestoreJob Resource
Get an existing CloudBackupSnapshotRestoreJob 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?: 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,
created_at: Optional[str] = None,
delivery_type: Optional[Mapping[str, str]] = None,
delivery_type_config: Optional[CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs] = None,
delivery_urls: Optional[Sequence[str]] = None,
expired: Optional[bool] = None,
expires_at: Optional[str] = None,
finished_at: Optional[str] = None,
project_id: Optional[str] = None,
snapshot_id: Optional[str] = None,
snapshot_restore_job_id: Optional[str] = None,
timestamp: Optional[str] = None) -> 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cancelled bool
Indicates whether the restore job was canceled.
- Cluster
Name string The name of the Atlas cluster whose snapshot you want to restore.
- Created
At string UTC ISO 8601 formatted point in time when Atlas created the restore job.
- Delivery
Type Dictionary<string, string> this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- Delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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 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.
- Expires
At string UTC ISO 8601 formatted point in time when the restore job expires.
- Finished
At string UTC ISO 8601 formatted point in time when the restore job completed.
- Project
Id string The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- Snapshot
Id string Unique identifier of the snapshot to restore.
- Snapshot
Restore stringJob Id The unique identifier of the restore job.
- Timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- Cancelled bool
Indicates whether the restore job was canceled.
- Cluster
Name string The name of the Atlas cluster whose snapshot you want to restore.
- Created
At string UTC ISO 8601 formatted point in time when Atlas created the restore job.
- Delivery
Type map[string]string this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- Delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config Args 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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 []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.
- Expires
At string UTC ISO 8601 formatted point in time when the restore job expires.
- Finished
At string UTC ISO 8601 formatted point in time when the restore job completed.
- Project
Id string The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- Snapshot
Id string Unique identifier of the snapshot to restore.
- Snapshot
Restore stringJob Id The unique identifier of the restore job.
- Timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled Boolean
Indicates whether the restore job was canceled.
- cluster
Name String The name of the Atlas cluster whose snapshot you want to restore.
- created
At String UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery
Type Map<String,String> this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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 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.
- expires
At String UTC ISO 8601 formatted point in time when the restore job expires.
- finished
At String UTC ISO 8601 formatted point in time when the restore job completed.
- project
Id String The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot
Id String Unique identifier of the snapshot to restore.
- snapshot
Restore StringJob Id The unique identifier of the restore job.
- timestamp String
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled boolean
Indicates whether the restore job was canceled.
- cluster
Name string The name of the Atlas cluster whose snapshot you want to restore.
- created
At string UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery
Type {[key: string]: string} this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery
Type CloudConfig Backup Snapshot Restore Job Delivery Type Config 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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 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.
- expires
At string UTC ISO 8601 formatted point in time when the restore job expires.
- finished
At string UTC ISO 8601 formatted point in time when the restore job completed.
- project
Id string The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot
Id string Unique identifier of the snapshot to restore.
- snapshot
Restore stringJob Id The unique identifier of the restore job.
- timestamp string
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled bool
Indicates whether the restore job was canceled.
- cluster_
name str The name of the Atlas cluster whose snapshot you want to restore.
- created_
at str UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery_
type Mapping[str, str] this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery_
type_ Cloudconfig Backup Snapshot Restore Job Delivery Type Config Args 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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.
- finished_
at str UTC ISO 8601 formatted point in time when the restore job completed.
- project_
id str The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot_
id str Unique identifier of the snapshot to restore.
- snapshot_
restore_ strjob_ id The unique identifier of the restore job.
- timestamp str
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
- cancelled Boolean
Indicates whether the restore job was canceled.
- cluster
Name String The name of the Atlas cluster whose snapshot you want to restore.
- created
At String UTC ISO 8601 formatted point in time when Atlas created the restore job.
- delivery
Type Map<String> this parameter is deprecated and will be removed in v1.12.0, please transition to delivery_type_config
- delivery
Type Property MapConfig 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 totrue
to use the automated configuration.delivery_type_config.download
- Set totrue
to use the download configuration.delivery_type_config.pointInTime
- Set totrue
to use the pointInTime configuration. If using pointInTime configuration, you must also specify eitheroplog_ts
andoplog_inc
, orpoint_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 withoplog_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 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.
- expires
At String UTC ISO 8601 formatted point in time when the restore job expires.
- finished
At String UTC ISO 8601 formatted point in time when the restore job completed.
- project
Id String The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
- snapshot
Id String Unique identifier of the snapshot to restore.
- snapshot
Restore StringJob Id The unique identifier of the restore job.
- timestamp String
Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
Supporting Types
CloudBackupSnapshotRestoreJobDeliveryTypeConfig, CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs
- Automated bool
- Download bool
- Oplog
Inc int - Oplog
Ts int - Point
In boolTime - Point
In intTime Utc Seconds - Target
Cluster stringName Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
- Target
Project stringId 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 boolTime - Point
In intTime Utc Seconds - Target
Cluster stringName Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
- Target
Project stringId Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
- automated Boolean
- download Boolean
- oplog
Inc Integer - oplog
Ts Integer - point
In BooleanTime - point
In IntegerTime Utc Seconds - target
Cluster StringName Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
- target
Project StringId Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
- automated boolean
- download boolean
- oplog
Inc number - oplog
Ts number - point
In booleanTime - point
In numberTime Utc Seconds - target
Cluster stringName Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
- target
Project stringId 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_ booltime - point_
in_ inttime_ utc_ seconds - target_
cluster_ strname Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
- target_
project_ strid Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
- automated Boolean
- download Boolean
- oplog
Inc Number - oplog
Ts Number - point
In BooleanTime - point
In NumberTime Utc Seconds - target
Cluster StringName Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
- target
Project StringId Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.