1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. CloudBackupSnapshot
MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi

mongodbatlas.CloudBackupSnapshot

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi

    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:

    ClusterName string

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    Description string

    Description of the on-demand snapshot.

    ProjectId string

    The unique identifier of the project for the Atlas cluster.

    RetentionInDays int

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    ClusterName string

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    Description string

    Description of the on-demand snapshot.

    ProjectId string

    The unique identifier of the project for the Atlas cluster.

    RetentionInDays int

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    clusterName String

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    description String

    Description of the on-demand snapshot.

    projectId String

    The unique identifier of the project for the Atlas cluster.

    retentionInDays Integer

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    clusterName string

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    description string

    Description of the on-demand snapshot.

    projectId string

    The unique identifier of the project for the Atlas cluster.

    retentionInDays number

    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_days int

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    clusterName String

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    description String

    Description of the on-demand snapshot.

    projectId String

    The unique identifier of the project for the Atlas cluster.

    retentionInDays Number

    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:

    CloudProvider string

    Cloud provider that stores this snapshot.

    CreatedAt string

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    ExpiresAt 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.

    MasterKeyUuid string

    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<CloudBackupSnapshotMember>

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    MongodVersion string

    Version of the MongoDB server.

    ReplicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    SnapshotId string

    Unique identifier of the snapshot.

    SnapshotIds List<string>

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    SnapshotType 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.

    StorageSizeBytes int

    Specifies the size of the snapshot in bytes.

    Type string

    Specifies the type of cluster: replicaSet or shardedCluster.

    CloudProvider string

    Cloud provider that stores this snapshot.

    CreatedAt string

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    ExpiresAt 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.

    MasterKeyUuid string

    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 []CloudBackupSnapshotMember

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    MongodVersion string

    Version of the MongoDB server.

    ReplicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    SnapshotId string

    Unique identifier of the snapshot.

    SnapshotIds []string

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    SnapshotType 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.

    StorageSizeBytes int

    Specifies the size of the snapshot in bytes.

    Type string

    Specifies the type of cluster: replicaSet or shardedCluster.

    cloudProvider String

    Cloud provider that stores this snapshot.

    createdAt String

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    expiresAt 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.

    masterKeyUuid String

    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<CloudBackupSnapshotMember>

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    mongodVersion String

    Version of the MongoDB server.

    replicaSetName String

    Label given to a shard or config server from which Atlas took this snapshot.

    snapshotId String

    Unique identifier of the snapshot.

    snapshotIds List<String>

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    snapshotType 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.

    storageSizeBytes Integer

    Specifies the size of the snapshot in bytes.

    type String

    Specifies the type of cluster: replicaSet or shardedCluster.

    cloudProvider string

    Cloud provider that stores this snapshot.

    createdAt string

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    expiresAt 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.

    masterKeyUuid string

    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 CloudBackupSnapshotMember[]

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    mongodVersion string

    Version of the MongoDB server.

    replicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    snapshotId string

    Unique identifier of the snapshot.

    snapshotIds string[]

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    snapshotType 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.

    storageSizeBytes number

    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_uuid str

    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[CloudBackupSnapshotMember]

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    mongod_version str

    Version of the MongoDB server.

    replica_set_name str

    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 is shardedCluster. These identifiers should match those given in the members[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_bytes int

    Specifies the size of the snapshot in bytes.

    type str

    Specifies the type of cluster: replicaSet or shardedCluster.

    cloudProvider String

    Cloud provider that stores this snapshot.

    createdAt String

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    expiresAt 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.

    masterKeyUuid String

    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 is shardedCluster. See below

    mongodVersion String

    Version of the MongoDB server.

    replicaSetName String

    Label given to a shard or config server from which Atlas took this snapshot.

    snapshotId String

    Unique identifier of the snapshot.

    snapshotIds List<String>

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    snapshotType 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.

    storageSizeBytes Number

    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.
    The following state arguments are supported:
    CloudProvider string

    Cloud provider that stores this snapshot.

    ClusterName string

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    CreatedAt string

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    Description string

    Description of the on-demand snapshot.

    ExpiresAt string

    UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

    MasterKeyUuid string

    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<CloudBackupSnapshotMember>

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    MongodVersion string

    Version of the MongoDB server.

    ProjectId string

    The unique identifier of the project for the Atlas cluster.

    ReplicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    RetentionInDays int

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    SnapshotId string

    Unique identifier of the snapshot.

    SnapshotIds List<string>

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    SnapshotType 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.

    StorageSizeBytes int

    Specifies the size of the snapshot in bytes.

    Type string

    Specifies the type of cluster: replicaSet or shardedCluster.

    CloudProvider string

    Cloud provider that stores this snapshot.

    ClusterName string

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    CreatedAt string

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    Description string

    Description of the on-demand snapshot.

    ExpiresAt string

    UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

    MasterKeyUuid string

    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 []CloudBackupSnapshotMemberArgs

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    MongodVersion string

    Version of the MongoDB server.

    ProjectId string

    The unique identifier of the project for the Atlas cluster.

    ReplicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    RetentionInDays int

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    SnapshotId string

    Unique identifier of the snapshot.

    SnapshotIds []string

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    SnapshotType 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.

    StorageSizeBytes int

    Specifies the size of the snapshot in bytes.

    Type string

    Specifies the type of cluster: replicaSet or shardedCluster.

    cloudProvider String

    Cloud provider that stores this snapshot.

    clusterName String

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    createdAt String

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    description String

    Description of the on-demand snapshot.

    expiresAt String

    UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

    masterKeyUuid String

    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<CloudBackupSnapshotMember>

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    mongodVersion String

    Version of the MongoDB server.

    projectId String

    The unique identifier of the project for the Atlas cluster.

    replicaSetName String

    Label given to a shard or config server from which Atlas took this snapshot.

    retentionInDays Integer

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    snapshotId String

    Unique identifier of the snapshot.

    snapshotIds List<String>

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    snapshotType 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.

    storageSizeBytes Integer

    Specifies the size of the snapshot in bytes.

    type String

    Specifies the type of cluster: replicaSet or shardedCluster.

    cloudProvider string

    Cloud provider that stores this snapshot.

    clusterName string

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    createdAt string

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    description string

    Description of the on-demand snapshot.

    expiresAt string

    UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

    masterKeyUuid string

    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 CloudBackupSnapshotMember[]

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below

    mongodVersion string

    Version of the MongoDB server.

    projectId string

    The unique identifier of the project for the Atlas cluster.

    replicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    retentionInDays number

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    snapshotId string

    Unique identifier of the snapshot.

    snapshotIds string[]

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    snapshotType 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.

    storageSizeBytes number

    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_uuid str

    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[CloudBackupSnapshotMemberArgs]

    Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. 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_name str

    Label given to a shard or config server from which Atlas took this snapshot.

    retention_in_days int

    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 is shardedCluster. These identifiers should match those given in the members[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_bytes int

    Specifies the size of the snapshot in bytes.

    type str

    Specifies the type of cluster: replicaSet or shardedCluster.

    cloudProvider String

    Cloud provider that stores this snapshot.

    clusterName String

    The name of the Atlas cluster that contains the snapshots you want to retrieve.

    createdAt String

    UTC ISO 8601 formatted point in time when Atlas took the snapshot.

    description String

    Description of the on-demand snapshot.

    expiresAt String

    UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

    masterKeyUuid String

    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 is shardedCluster. See below

    mongodVersion String

    Version of the MongoDB server.

    projectId String

    The unique identifier of the project for the Atlas cluster.

    replicaSetName String

    Label given to a shard or config server from which Atlas took this snapshot.

    retentionInDays Number

    The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

    snapshotId String

    Unique identifier of the snapshot.

    snapshotIds List<String>

    Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name.

    snapshotType 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.

    storageSizeBytes Number

    Specifies the size of the snapshot in bytes.

    type String

    Specifies the type of cluster: replicaSet or shardedCluster.

    Supporting Types

    CloudBackupSnapshotMember, CloudBackupSnapshotMemberArgs

    CloudProvider string

    Cloud provider that stores this snapshot.

    Id string

    Unique identifier for the sharded cluster snapshot.

    ReplicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    CloudProvider string

    Cloud provider that stores this snapshot.

    Id string

    Unique identifier for the sharded cluster snapshot.

    ReplicaSetName string

    Label given to a shard or config server from which Atlas took this snapshot.

    cloudProvider String

    Cloud provider that stores this snapshot.

    id String

    Unique identifier for the sharded cluster snapshot.

    replicaSetName String

    Label given to a shard or config server from which Atlas took this snapshot.

    cloudProvider string

    Cloud provider that stores this snapshot.

    id string

    Unique identifier for the sharded cluster snapshot.

    replicaSetName string

    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_name str

    Label given to a shard or config server from which Atlas took this snapshot.

    cloudProvider String

    Cloud provider that stores this snapshot.

    id String

    Unique identifier for the sharded cluster snapshot.

    replicaSetName String

    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.

    mongodbatlas logo
    MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi