mongodbatlas.CloudBackupSnapshot
Explore with Pulumi AI
Import
Cloud Backup Snapshot entries can be imported using project project_id, cluster_name and snapshot_id (Unique identifier of the snapshot), in the format PROJECTID-CLUSTERNAME-SNAPSHOTID
, e.g.
$ pulumi import mongodbatlas:index/cloudBackupSnapshot:CloudBackupSnapshot test 5d0f1f73cf09a29120e173cf-MyClusterTest-5d116d82014b764445b2f9b5
For more information seeMongoDB Atlas API Reference.
Example Usage
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Cluster;
import com.pulumi.mongodbatlas.ClusterArgs;
import com.pulumi.mongodbatlas.CloudBackupSnapshot;
import com.pulumi.mongodbatlas.CloudBackupSnapshotArgs;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJob;
import com.pulumi.mongodbatlas.CloudBackupSnapshotRestoreJobArgs;
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 Cluster("myCluster", ClusterArgs.builder()
.projectId("5cf5a45a9ccf6400e60981b6")
.providerName("AWS")
.providerRegionName("EU_WEST_2")
.providerInstanceSizeName("M10")
.cloudBackup(true)
.build());
var testCloudBackupSnapshot = new CloudBackupSnapshot("testCloudBackupSnapshot", CloudBackupSnapshotArgs.builder()
.projectId(myCluster.projectId())
.clusterName(myCluster.name())
.description("myDescription")
.retentionInDays(1)
.build());
var testCloudBackupSnapshotRestoreJob = new CloudBackupSnapshotRestoreJob("testCloudBackupSnapshotRestoreJob", CloudBackupSnapshotRestoreJobArgs.builder()
.projectId(testCloudBackupSnapshot.projectId())
.clusterName(testCloudBackupSnapshot.clusterName())
.snapshotId(testCloudBackupSnapshot.snapshotId())
.deliveryType(Map.of("download", true))
.build());
}
}
Coming soon!
Coming soon!
resources:
myCluster:
type: mongodbatlas:Cluster
properties:
projectId: 5cf5a45a9ccf6400e60981b6
# Provider Settings "block"
providerName: AWS
providerRegionName: EU_WEST_2
providerInstanceSizeName: M10
cloudBackup: true
testCloudBackupSnapshot:
type: mongodbatlas:CloudBackupSnapshot
properties:
projectId: ${myCluster.projectId}
clusterName: ${myCluster.name}
description: myDescription
retentionInDays: 1
testCloudBackupSnapshotRestoreJob:
type: mongodbatlas:CloudBackupSnapshotRestoreJob
properties:
projectId: ${testCloudBackupSnapshot.projectId}
clusterName: ${testCloudBackupSnapshot.clusterName}
snapshotId: ${testCloudBackupSnapshot.snapshotId}
deliveryType:
- download: true
Create CloudBackupSnapshot Resource
new CloudBackupSnapshot(name: string, args: CloudBackupSnapshotArgs, opts?: CustomResourceOptions);
@overload
def CloudBackupSnapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
description: Optional[str] = None,
project_id: Optional[str] = None,
retention_in_days: Optional[int] = None)
@overload
def CloudBackupSnapshot(resource_name: str,
args: CloudBackupSnapshotArgs,
opts: Optional[ResourceOptions] = None)
func NewCloudBackupSnapshot(ctx *Context, name string, args CloudBackupSnapshotArgs, opts ...ResourceOption) (*CloudBackupSnapshot, error)
public CloudBackupSnapshot(string name, CloudBackupSnapshotArgs args, CustomResourceOptions? opts = null)
public CloudBackupSnapshot(String name, CloudBackupSnapshotArgs args)
public CloudBackupSnapshot(String name, CloudBackupSnapshotArgs args, CustomResourceOptions options)
type: mongodbatlas:CloudBackupSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudBackupSnapshotArgs
- 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 CloudBackupSnapshotArgs
- 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 CloudBackupSnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudBackupSnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CloudBackupSnapshotArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CloudBackupSnapshot 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 CloudBackupSnapshot resource accepts the following input properties:
- Cluster
Name string The name of the Atlas cluster that contains the snapshots you want to retrieve.
- Description string
Description of the on-demand snapshot.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Retention
In intDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- Cluster
Name string The name of the Atlas cluster that contains the snapshots you want to retrieve.
- Description string
Description of the on-demand snapshot.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Retention
In intDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- cluster
Name String The name of the Atlas cluster that contains the snapshots you want to retrieve.
- description String
Description of the on-demand snapshot.
- project
Id String The unique identifier of the project for the Atlas cluster.
- retention
In IntegerDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- cluster
Name string The name of the Atlas cluster that contains the snapshots you want to retrieve.
- description string
Description of the on-demand snapshot.
- project
Id string The unique identifier of the project for the Atlas cluster.
- retention
In numberDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- cluster_
name str The name of the Atlas cluster that contains the snapshots you want to retrieve.
- description str
Description of the on-demand snapshot.
- project_
id str The unique identifier of the project for the Atlas cluster.
- retention_
in_ intdays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- cluster
Name String The name of the Atlas cluster that contains the snapshots you want to retrieve.
- description String
Description of the on-demand snapshot.
- project
Id String The unique identifier of the project for the Atlas cluster.
- retention
In NumberDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudBackupSnapshot resource produces the following output properties:
- Cloud
Provider string Cloud provider that stores this snapshot.
- Created
At string UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- Expires
At string UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- Id string
The provider-assigned unique ID for this managed resource.
- Master
Key stringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- Members
List<Cloud
Backup Snapshot Member> Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- Mongod
Version string Version of the MongoDB server.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Snapshot
Id string Unique identifier of the snapshot.
- Snapshot
Ids List<string> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- Snapshot
Type string Specified the type of snapshot. Valid values are onDemand and scheduled.
- Status string
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- Storage
Size intBytes Specifies the size of the snapshot in bytes.
- Type string
Specifies the type of cluster: replicaSet or shardedCluster.
- Cloud
Provider string Cloud provider that stores this snapshot.
- Created
At string UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- Expires
At string UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- Id string
The provider-assigned unique ID for this managed resource.
- Master
Key stringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- Members
[]Cloud
Backup Snapshot Member Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- Mongod
Version string Version of the MongoDB server.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Snapshot
Id string Unique identifier of the snapshot.
- Snapshot
Ids []string Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- Snapshot
Type string Specified the type of snapshot. Valid values are onDemand and scheduled.
- Status string
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- Storage
Size intBytes Specifies the size of the snapshot in bytes.
- Type string
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider String Cloud provider that stores this snapshot.
- created
At String UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- expires
At String UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- id String
The provider-assigned unique ID for this managed resource.
- master
Key StringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members
List<Cloud
Backup Snapshot Member> Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod
Version String Version of the MongoDB server.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- snapshot
Id String Unique identifier of the snapshot.
- snapshot
Ids List<String> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot
Type String Specified the type of snapshot. Valid values are onDemand and scheduled.
- status String
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage
Size IntegerBytes Specifies the size of the snapshot in bytes.
- type String
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider string Cloud provider that stores this snapshot.
- created
At string UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- expires
At string UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- id string
The provider-assigned unique ID for this managed resource.
- master
Key stringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members
Cloud
Backup Snapshot Member[] Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod
Version string Version of the MongoDB server.
- replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- snapshot
Id string Unique identifier of the snapshot.
- snapshot
Ids string[] Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot
Type string Specified the type of snapshot. Valid values are onDemand and scheduled.
- status string
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage
Size numberBytes Specifies the size of the snapshot in bytes.
- type string
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud_
provider str Cloud provider that stores this snapshot.
- created_
at str UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- expires_
at str UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- id str
The provider-assigned unique ID for this managed resource.
- master_
key_ struuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members
Sequence[Cloud
Backup Snapshot Member] Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod_
version str Version of the MongoDB server.
- replica_
set_ strname Label given to a shard or config server from which Atlas took this snapshot.
- snapshot_
id str Unique identifier of the snapshot.
- snapshot_
ids Sequence[str] Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot_
type str Specified the type of snapshot. Valid values are onDemand and scheduled.
- status str
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage_
size_ intbytes Specifies the size of the snapshot in bytes.
- type str
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider String Cloud provider that stores this snapshot.
- created
At String UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- expires
At String UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- id String
The provider-assigned unique ID for this managed resource.
- master
Key StringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members List<Property Map>
Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod
Version String Version of the MongoDB server.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- snapshot
Id String Unique identifier of the snapshot.
- snapshot
Ids List<String> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot
Type String Specified the type of snapshot. Valid values are onDemand and scheduled.
- status String
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage
Size NumberBytes Specifies the size of the snapshot in bytes.
- type String
Specifies the type of cluster: replicaSet or shardedCluster.
Look up Existing CloudBackupSnapshot Resource
Get an existing CloudBackupSnapshot 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?: CloudBackupSnapshotState, opts?: CustomResourceOptions): CloudBackupSnapshot
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cloud_provider: Optional[str] = None,
cluster_name: Optional[str] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
expires_at: Optional[str] = None,
master_key_uuid: Optional[str] = None,
members: Optional[Sequence[CloudBackupSnapshotMemberArgs]] = None,
mongod_version: Optional[str] = None,
project_id: Optional[str] = None,
replica_set_name: Optional[str] = None,
retention_in_days: Optional[int] = None,
snapshot_id: Optional[str] = None,
snapshot_ids: Optional[Sequence[str]] = None,
snapshot_type: Optional[str] = None,
status: Optional[str] = None,
storage_size_bytes: Optional[int] = None,
type: Optional[str] = None) -> CloudBackupSnapshot
func GetCloudBackupSnapshot(ctx *Context, name string, id IDInput, state *CloudBackupSnapshotState, opts ...ResourceOption) (*CloudBackupSnapshot, error)
public static CloudBackupSnapshot Get(string name, Input<string> id, CloudBackupSnapshotState? state, CustomResourceOptions? opts = null)
public static CloudBackupSnapshot get(String name, Output<String> id, CloudBackupSnapshotState 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.
- Cloud
Provider string Cloud provider that stores this snapshot.
- Cluster
Name string The name of the Atlas cluster that contains the snapshots you want to retrieve.
- Created
At string UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- Description string
Description of the on-demand snapshot.
- Expires
At string UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- Master
Key stringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- Members
List<Cloud
Backup Snapshot Member> Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- Mongod
Version string Version of the MongoDB server.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Retention
In intDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- Snapshot
Id string Unique identifier of the snapshot.
- Snapshot
Ids List<string> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- Snapshot
Type string Specified the type of snapshot. Valid values are onDemand and scheduled.
- Status string
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- Storage
Size intBytes Specifies the size of the snapshot in bytes.
- Type string
Specifies the type of cluster: replicaSet or shardedCluster.
- Cloud
Provider string Cloud provider that stores this snapshot.
- Cluster
Name string The name of the Atlas cluster that contains the snapshots you want to retrieve.
- Created
At string UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- Description string
Description of the on-demand snapshot.
- Expires
At string UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- Master
Key stringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- Members
[]Cloud
Backup Snapshot Member Args Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- Mongod
Version string Version of the MongoDB server.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Retention
In intDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- Snapshot
Id string Unique identifier of the snapshot.
- Snapshot
Ids []string Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- Snapshot
Type string Specified the type of snapshot. Valid values are onDemand and scheduled.
- Status string
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- Storage
Size intBytes Specifies the size of the snapshot in bytes.
- Type string
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider String Cloud provider that stores this snapshot.
- cluster
Name String The name of the Atlas cluster that contains the snapshots you want to retrieve.
- created
At String UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- description String
Description of the on-demand snapshot.
- expires
At String UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- master
Key StringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members
List<Cloud
Backup Snapshot Member> Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod
Version String Version of the MongoDB server.
- project
Id String The unique identifier of the project for the Atlas cluster.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- retention
In IntegerDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- snapshot
Id String Unique identifier of the snapshot.
- snapshot
Ids List<String> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot
Type String Specified the type of snapshot. Valid values are onDemand and scheduled.
- status String
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage
Size IntegerBytes Specifies the size of the snapshot in bytes.
- type String
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider string Cloud provider that stores this snapshot.
- cluster
Name string The name of the Atlas cluster that contains the snapshots you want to retrieve.
- created
At string UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- description string
Description of the on-demand snapshot.
- expires
At string UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- master
Key stringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members
Cloud
Backup Snapshot Member[] Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod
Version string Version of the MongoDB server.
- project
Id string The unique identifier of the project for the Atlas cluster.
- replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- retention
In numberDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- snapshot
Id string Unique identifier of the snapshot.
- snapshot
Ids string[] Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot
Type string Specified the type of snapshot. Valid values are onDemand and scheduled.
- status string
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage
Size numberBytes Specifies the size of the snapshot in bytes.
- type string
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud_
provider str Cloud provider that stores this snapshot.
- cluster_
name str The name of the Atlas cluster that contains the snapshots you want to retrieve.
- created_
at str UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- description str
Description of the on-demand snapshot.
- expires_
at str UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- master_
key_ struuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members
Sequence[Cloud
Backup Snapshot Member Args] Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod_
version str Version of the MongoDB server.
- project_
id str The unique identifier of the project for the Atlas cluster.
- replica_
set_ strname Label given to a shard or config server from which Atlas took this snapshot.
- retention_
in_ intdays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- snapshot_
id str Unique identifier of the snapshot.
- snapshot_
ids Sequence[str] Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot_
type str Specified the type of snapshot. Valid values are onDemand and scheduled.
- status str
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage_
size_ intbytes Specifies the size of the snapshot in bytes.
- type str
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider String Cloud provider that stores this snapshot.
- cluster
Name String The name of the Atlas cluster that contains the snapshots you want to retrieve.
- created
At String UTC ISO 8601 formatted point in time when Atlas took the snapshot.
- description String
Description of the on-demand snapshot.
- expires
At String UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
- master
Key StringUuid Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
- members List<Property Map>
Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when
type
isshardedCluster
. See below- mongod
Version String Version of the MongoDB server.
- project
Id String The unique identifier of the project for the Atlas cluster.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- retention
In NumberDays The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.
- snapshot
Id String Unique identifier of the snapshot.
- snapshot
Ids List<String> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when
type
isshardedCluster
. These identifiers should match those given in themembers[n].id
parameters. This allows you to map a snapshot to its shard or config server name.- snapshot
Type String Specified the type of snapshot. Valid values are onDemand and scheduled.
- status String
Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.
- storage
Size NumberBytes Specifies the size of the snapshot in bytes.
- type String
Specifies the type of cluster: replicaSet or shardedCluster.
Supporting Types
CloudBackupSnapshotMember, CloudBackupSnapshotMemberArgs
- Cloud
Provider string Cloud provider that stores this snapshot.
- Id string
Unique identifier for the sharded cluster snapshot.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Cloud
Provider string Cloud provider that stores this snapshot.
- Id string
Unique identifier for the sharded cluster snapshot.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- cloud
Provider String Cloud provider that stores this snapshot.
- id String
Unique identifier for the sharded cluster snapshot.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- cloud
Provider string Cloud provider that stores this snapshot.
- id string
Unique identifier for the sharded cluster snapshot.
- replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- cloud_
provider str Cloud provider that stores this snapshot.
- id str
Unique identifier for the sharded cluster snapshot.
- replica_
set_ strname Label given to a shard or config server from which Atlas took this snapshot.
- cloud
Provider String Cloud provider that stores this snapshot.
- id String
Unique identifier for the sharded cluster snapshot.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.