com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.mongodbatlas;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
import com.pulumi.mongodbatlas.Utilities;
import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobState;
import com.pulumi.mongodbatlas.outputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfig;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* ## Example Usage
*
* ### Example automated delivery type
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.mongodbatlas.AdvancedCluster;
* import com.pulumi.mongodbatlas.AdvancedClusterArgs;
* import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
* import com.pulumi.mongodbatlas.cloudProviderSnapshot;
* import com.pulumi.mongodbatlas.CloudProviderSnapshotArgs;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
* import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var myCluster = new AdvancedCluster("myCluster", AdvancedClusterArgs.builder()
* .projectId("")
* .name("MyCluster")
* .clusterType("REPLICASET")
* .backupEnabled(true)
* .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
* .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
* .priority(7)
* .providerName("AWS")
* .regionName("EU_WEST_2")
* .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
* .instanceSize("M10")
* .nodeCount(3)
* .build())
* .build())
* .build())
* .build());
*
* var test = new CloudProviderSnapshot("test", CloudProviderSnapshotArgs.builder()
* .projectId(myCluster.projectId())
* .clusterName(myCluster.name())
* .description("myDescription")
* .retentionInDays(1)
* .build());
*
* var testCloudBackupSnapshotRestoreJob = new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob", CloudBackupSnapshotRestoreJobArgs.builder()
* .projectId(test.projectId())
* .clusterName(test.clusterName())
* .snapshotId(test.snapshotId())
* .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
* .automated(true)
* .targetClusterName("MyCluster")
* .targetProjectId("5cf5a45a9ccf6400e60981b6")
* .build())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Example download delivery type
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.mongodbatlas.AdvancedCluster;
* import com.pulumi.mongodbatlas.AdvancedClusterArgs;
* import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
* import com.pulumi.mongodbatlas.cloudProviderSnapshot;
* import com.pulumi.mongodbatlas.CloudProviderSnapshotArgs;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
* import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var myCluster = new AdvancedCluster("myCluster", AdvancedClusterArgs.builder()
* .projectId("")
* .name("MyCluster")
* .clusterType("REPLICASET")
* .backupEnabled(true)
* .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
* .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
* .priority(7)
* .providerName("AWS")
* .regionName("EU_WEST_2")
* .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
* .instanceSize("M10")
* .nodeCount(3)
* .build())
* .build())
* .build())
* .build());
*
* var test = new CloudProviderSnapshot("test", CloudProviderSnapshotArgs.builder()
* .projectId(myCluster.projectId())
* .clusterName(myCluster.name())
* .description("myDescription")
* .retentionInDays(1)
* .build());
*
* var testCloudBackupSnapshotRestoreJob = new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob", CloudBackupSnapshotRestoreJobArgs.builder()
* .projectId(test.projectId())
* .clusterName(test.clusterName())
* .snapshotId(test.snapshotId())
* .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
* .download(true)
* .build())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Example of a point in time restore
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.mongodbatlas.AdvancedCluster;
* import com.pulumi.mongodbatlas.AdvancedClusterArgs;
* import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
* import com.pulumi.mongodbatlas.CloudBackupSnapshot;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotArgs;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
* import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
* import com.pulumi.mongodbatlas.inputs.CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs;
* import com.pulumi.codegen.internal.KeyedValue;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var myCluster = new AdvancedCluster("myCluster", AdvancedClusterArgs.builder()
* .projectId("")
* .name("MyCluster")
* .clusterType("REPLICASET")
* .backupEnabled(true)
* .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
* .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
* .priority(7)
* .providerName("AWS")
* .regionName("EU_WEST_2")
* .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
* .instanceSize("M10")
* .nodeCount(3)
* .build())
* .build())
* .build())
* .build());
*
* var test = new CloudBackupSnapshot("test", CloudBackupSnapshotArgs.builder()
* .projectId(clusterTest.projectId())
* .clusterName(clusterTest.name())
* .description("My description")
* .retentionInDays("1")
* .build());
*
* for (var i = 0; i < (pointInTimeUtcSeconds == 0 ? 0 : 1); i++) {
* new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob-" + i, CloudBackupSnapshotRestoreJobArgs.builder()
* .projectId(test.projectId())
* .clusterName(test.clusterName())
* .snapshotId(test.id())
* .deliveryTypeConfig(CloudBackupSnapshotRestoreJobDeliveryTypeConfigArgs.builder()
* .pointInTime(true)
* .targetClusterName(clusterTest.name())
* .targetProjectId(clusterTest.projectId())
* .pointInTimeUtcSeconds(pointInTimeUtcSeconds)
* .build())
* .build());
*
*
* }
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Available complete examples
* - Restore from backup snapshot at point in time
* - Restore from backup snapshot using an advanced cluster resource
*
* ## 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.
*
* ```sh
* $ pulumi import mongodbatlas:index/cloudBackupSnapshotRestoreJob:CloudBackupSnapshotRestoreJob test 5cf5a45a9ccf6400e60981b6-MyCluster-5d1b654ecf09a24b888f4c79
* ```
* For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/cloud-backup/restore/restores/)
*
*/
@ResourceType(type="mongodbatlas:index/cloudBackupSnapshotRestoreJob:CloudBackupSnapshotRestoreJob")
public class CloudBackupSnapshotRestoreJob extends com.pulumi.resources.CustomResource {
/**
* Indicates whether the restore job was canceled.
*
*/
@Export(name="cancelled", refs={Boolean.class}, tree="[0]")
private Output cancelled;
/**
* @return Indicates whether the restore job was canceled.
*
*/
public Output cancelled() {
return this.cancelled;
}
/**
* The name of the Atlas cluster whose snapshot you want to restore.
*
*/
@Export(name="clusterName", refs={String.class}, tree="[0]")
private Output clusterName;
/**
* @return The name of the Atlas cluster whose snapshot you want to restore.
*
*/
public Output clusterName() {
return this.clusterName;
}
/**
* Type of restore job to create. Possible configurations are: **download**, **automated**, or **pointInTime** only one must be set it in ``true``.
* * `delivery_type_config.automated` - Set to `true` to use the automated configuration.
* * `delivery_type_config.download` - Set to `true` to use the download configuration.
* * `delivery_type_config.pointInTime` - Set to `true` to use the pointInTime configuration. If using pointInTime configuration, you must also specify either `oplog_ts` and `oplog_inc`, or `point_in_time_utc_seconds`.
* * `delivery_type_config.target_cluster_name` - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for **automated** and **pointInTime**.
* * `delivery_type_config.target_project_id` - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for **automated** and **pointInTime**.
* * `delivery_type_config.oplog_ts` - Optional setting for **pointInTime** configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
* * `delivery_type_config.oplog_inc` - Optional setting for **pointInTime** configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with `oplog_ts`.
* * `delivery_type_config.point_in_time_utc_seconds` - Optional setting for **pointInTime** configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.
*
*/
@Export(name="deliveryTypeConfig", refs={CloudBackupSnapshotRestoreJobDeliveryTypeConfig.class}, tree="[0]")
private Output deliveryTypeConfig;
/**
* @return Type of restore job to create. Possible configurations are: **download**, **automated**, or **pointInTime** only one must be set it in ``true``.
* * `delivery_type_config.automated` - Set to `true` to use the automated configuration.
* * `delivery_type_config.download` - Set to `true` to use the download configuration.
* * `delivery_type_config.pointInTime` - Set to `true` to use the pointInTime configuration. If using pointInTime configuration, you must also specify either `oplog_ts` and `oplog_inc`, or `point_in_time_utc_seconds`.
* * `delivery_type_config.target_cluster_name` - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for **automated** and **pointInTime**.
* * `delivery_type_config.target_project_id` - Name of the target Atlas cluster to which the restore job restores the snapshot. Required for **automated** and **pointInTime**.
* * `delivery_type_config.oplog_ts` - Optional setting for **pointInTime** configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This is the first part of an Oplog timestamp.
* * `delivery_type_config.oplog_inc` - Optional setting for **pointInTime** configuration. Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp. Used in conjunction with `oplog_ts`.
* * `delivery_type_config.point_in_time_utc_seconds` - Optional setting for **pointInTime** configuration. Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot. Used instead of oplog settings.
*
*/
public Output> deliveryTypeConfig() {
return Codegen.optional(this.deliveryTypeConfig);
}
/**
* One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
*
*/
@Export(name="deliveryUrls", refs={List.class,String.class}, tree="[0,1]")
private Output> deliveryUrls;
/**
* @return One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
*
*/
public Output> deliveryUrls() {
return this.deliveryUrls;
}
/**
* Indicates whether the restore job expired.
*
*/
@Export(name="expired", refs={Boolean.class}, tree="[0]")
private Output expired;
/**
* @return Indicates whether the restore job expired.
*
*/
public Output expired() {
return this.expired;
}
/**
* UTC ISO 8601 formatted point in time when the restore job expires.
*
*/
@Export(name="expiresAt", refs={String.class}, tree="[0]")
private Output expiresAt;
/**
* @return UTC ISO 8601 formatted point in time when the restore job expires.
*
*/
public Output expiresAt() {
return this.expiresAt;
}
/**
* UTC ISO 8601 formatted point in time when the restore job completed.
*
*/
@Export(name="finishedAt", refs={String.class}, tree="[0]")
private Output finishedAt;
/**
* @return UTC ISO 8601 formatted point in time when the restore job completed.
*
*/
public Output finishedAt() {
return this.finishedAt;
}
/**
* The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
*
*/
@Export(name="projectId", refs={String.class}, tree="[0]")
private Output projectId;
/**
* @return The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.
*
*/
public Output projectId() {
return this.projectId;
}
/**
* Optional setting for **pointInTime** configuration. Unique identifier of the snapshot to restore.
*
*/
@Export(name="snapshotId", refs={String.class}, tree="[0]")
private Output snapshotId;
/**
* @return Optional setting for **pointInTime** configuration. Unique identifier of the snapshot to restore.
*
*/
public Output> snapshotId() {
return Codegen.optional(this.snapshotId);
}
/**
* The unique identifier of the restore job.
*
*/
@Export(name="snapshotRestoreJobId", refs={String.class}, tree="[0]")
private Output snapshotRestoreJobId;
/**
* @return The unique identifier of the restore job.
*
*/
public Output snapshotRestoreJobId() {
return this.snapshotRestoreJobId;
}
/**
* Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
* * `oplogTs` - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot.
* Three conditions apply to this parameter:
* * Enable Continuous Cloud Backup on your cluster.
* * Specify oplogInc.
* * Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
* * `oplogInc` - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp.
* Three conditions apply to this parameter:
* * Enable Continuous Cloud Backup on your cluster.
* * Specify oplogTs.
* * Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
* * `pointInTimeUTCSeconds` - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot.
* Two conditions apply to this parameter:
* * Enable Continuous Cloud Backup on your cluster.
* * Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.
*
*/
@Export(name="timestamp", refs={String.class}, tree="[0]")
private Output timestamp;
/**
* @return Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
* * `oplogTs` - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot.
* Three conditions apply to this parameter:
* * Enable Continuous Cloud Backup on your cluster.
* * Specify oplogInc.
* * Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
* * `oplogInc` - Oplog operation number from which to you want to restore this snapshot. This is the second part of an Oplog timestamp.
* Three conditions apply to this parameter:
* * Enable Continuous Cloud Backup on your cluster.
* * Specify oplogTs.
* * Specify either oplogTs and oplogInc or pointInTimeUTCSeconds, but not both.
* * `pointInTimeUTCSeconds` - Timestamp in the number of seconds that have elapsed since the UNIX epoch from which you want to restore this snapshot.
* Two conditions apply to this parameter:
* * Enable Continuous Cloud Backup on your cluster.
* * Specify either pointInTimeUTCSeconds or oplogTs and oplogInc, but not both.
*
*/
public Output timestamp() {
return this.timestamp;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public CloudBackupSnapshotRestoreJob(java.lang.String name) {
this(name, CloudBackupSnapshotRestoreJobArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public CloudBackupSnapshotRestoreJob(java.lang.String name, CloudBackupSnapshotRestoreJobArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public CloudBackupSnapshotRestoreJob(java.lang.String name, CloudBackupSnapshotRestoreJobArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("mongodbatlas:index/cloudBackupSnapshotRestoreJob:CloudBackupSnapshotRestoreJob", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private CloudBackupSnapshotRestoreJob(java.lang.String name, Output id, @Nullable CloudBackupSnapshotRestoreJobState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("mongodbatlas:index/cloudBackupSnapshotRestoreJob:CloudBackupSnapshotRestoreJob", name, state, makeResourceOptions(options, id), false);
}
private static CloudBackupSnapshotRestoreJobArgs makeArgs(CloudBackupSnapshotRestoreJobArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? CloudBackupSnapshotRestoreJobArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static CloudBackupSnapshotRestoreJob get(java.lang.String name, Output id, @Nullable CloudBackupSnapshotRestoreJobState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new CloudBackupSnapshotRestoreJob(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy