MongoDB Atlas v3.30.0, Mar 21 25

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getCloudBackupSnapshots

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

# Data Source: mongodbatlas.getCloudBackupSnapshots

mongodbatlas.getCloudBackupSnapshots provides an Cloud Backup Snapshot datasource. Atlas Cloud Backup Snapshots provide localized backup storage using the native snapshot functionality of the cluster’s cloud service.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.cloudBackupSnapshots;
import com.pulumi.mongodbatlas.CloudBackupSnapshotsArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetCloudBackupSnapshotsArgs;
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 testCloudBackupSnapshots = new CloudBackupSnapshots("testCloudBackupSnapshots", CloudBackupSnapshotsArgs.builder()
            .groupId("5d0f1f73cf09a29120e173cf")
            .clusterName("MyClusterTest")
            .description("SomeDescription")
            .retentionInDays(1)
            .build());

        final var test = MongodbatlasFunctions.getCloudBackupSnapshots(GetCloudBackupSnapshotsArgs.builder()
            .groupId(testCloudBackupSnapshots.groupId())
            .clusterName(testCloudBackupSnapshots.clusterName())
            .pageNum(1)
            .itemsPerPage(5)
            .build());

    }
}

resources:
  testCloudBackupSnapshots:
    type: mongodbatlas:cloudBackupSnapshots
    name: test
    properties:
      groupId: 5d0f1f73cf09a29120e173cf
      clusterName: MyClusterTest
      description: SomeDescription
      retentionInDays: 1
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getCloudBackupSnapshots
      arguments:
        groupId: ${testCloudBackupSnapshots.groupId}
        clusterName: ${testCloudBackupSnapshots.clusterName}
        pageNum: 1
        itemsPerPage: 5

Using getCloudBackupSnapshots

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCloudBackupSnapshots(args: GetCloudBackupSnapshotsArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotsResult>
function getCloudBackupSnapshotsOutput(args: GetCloudBackupSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotsResult>

def get_cloud_backup_snapshots(cluster_name: Optional[str] = None,
                               items_per_page: Optional[int] = None,
                               page_num: Optional[int] = None,
                               project_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotsResult
def get_cloud_backup_snapshots_output(cluster_name: Optional[pulumi.Input[str]] = None,
                               items_per_page: Optional[pulumi.Input[int]] = None,
                               page_num: Optional[pulumi.Input[int]] = None,
                               project_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetCloudBackupSnapshotsResult]

func LookupCloudBackupSnapshots(ctx *Context, args *LookupCloudBackupSnapshotsArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotsResult, error)
func LookupCloudBackupSnapshotsOutput(ctx *Context, args *LookupCloudBackupSnapshotsOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotsResultOutput

> Note: This function is named LookupCloudBackupSnapshots in the Go SDK.

public static class GetCloudBackupSnapshots 
{
    public static Task<GetCloudBackupSnapshotsResult> InvokeAsync(GetCloudBackupSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotsResult> Invoke(GetCloudBackupSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudBackupSnapshotsResult> getCloudBackupSnapshots(GetCloudBackupSnapshotsArgs args, InvokeOptions options)
public static Output<GetCloudBackupSnapshotsResult> getCloudBackupSnapshots(GetCloudBackupSnapshotsArgs args, InvokeOptions options)

fn::invoke:
  function: mongodbatlas:index/getCloudBackupSnapshots:getCloudBackupSnapshots
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: The name of the Atlas cluster that contains the snapshot you want to retrieve.
ProjectId string
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

ClusterName string: The name of the Atlas cluster that contains the snapshot you want to retrieve.
ProjectId string
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

clusterName String: The name of the Atlas cluster that contains the snapshot you want to retrieve.
projectId String
itemsPerPage Integer: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Integer: The page to return. Defaults to 1.

clusterName string: The name of the Atlas cluster that contains the snapshot you want to retrieve.
projectId string
itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum number: The page to return. Defaults to 1.

cluster_name str: The name of the Atlas cluster that contains the snapshot you want to retrieve.
project_id str
items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
page_num int: The page to return. Defaults to 1.

clusterName String: The name of the Atlas cluster that contains the snapshot you want to retrieve.
projectId String
itemsPerPage Number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Number: The page to return. Defaults to 1.

getCloudBackupSnapshots Result

The following output properties are available:

ClusterName string

Id string

The provider-assigned unique ID for this managed resource.

ProjectId string

Results List<GetCloudBackupSnapshotsResult>

Includes cloudProviderSnapshot object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

TotalCount int

ItemsPerPage int

PageNum int

ClusterName string

Id string

The provider-assigned unique ID for this managed resource.

ProjectId string

Results []GetCloudBackupSnapshotsResult

Includes cloudProviderSnapshot object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

TotalCount int

ItemsPerPage int

PageNum int

clusterName String

id String

The provider-assigned unique ID for this managed resource.

projectId String

results List<GetCloudBackupSnapshotsResult>

Includes cloudProviderSnapshot object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

totalCount Integer

itemsPerPage Integer

pageNum Integer

clusterName string

id string

The provider-assigned unique ID for this managed resource.

projectId string

results GetCloudBackupSnapshotsResult[]

Includes cloudProviderSnapshot object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

totalCount number

itemsPerPage number

pageNum number

cluster_name str

id str

The provider-assigned unique ID for this managed resource.

project_id str

results Sequence[GetCloudBackupSnapshotsResult]

Includes cloudProviderSnapshot object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

total_count int

items_per_page int

page_num int

clusterName String

id String

The provider-assigned unique ID for this managed resource.

projectId String

results List<Property Map>

Includes cloudProviderSnapshot object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

totalCount Number

itemsPerPage Number

pageNum Number

Supporting Types

GetCloudBackupSnapshotsResult

CloudProvider string: Cloud provider that stores this snapshot.
CreatedAt string: UTC ISO 8601 formatted point in time when Atlas took the snapshot.
Description string: UDescription of the snapshot. Only present for on-demand snapshots.
ExpiresAt string: UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
Id string: Unique identifier for the sharded cluster 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<GetCloudBackupSnapshotsResultMember>: Block of List of snapshots and the cloud provider where the snapshots are stored. 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.
SnapshotIds List<string>: Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
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: 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.
Description string: UDescription of the snapshot. Only present for on-demand snapshots.
ExpiresAt string: UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
Id string: Unique identifier for the sharded cluster 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 []GetCloudBackupSnapshotsResultMember: Block of List of snapshots and the cloud provider where the snapshots are stored. 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.
SnapshotIds []string: Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
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: 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.
description String: UDescription of the snapshot. Only present for on-demand snapshots.
expiresAt String: UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
id String: Unique identifier for the sharded cluster 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<GetCloudBackupSnapshotsResultMember>: Block of List of snapshots and the cloud provider where the snapshots are stored. 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.
snapshotIds List<String>: Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
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: 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.
description string: UDescription of the snapshot. Only present for on-demand snapshots.
expiresAt string: UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
id string: Unique identifier for the sharded cluster 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 GetCloudBackupSnapshotsResultMember[]: Block of List of snapshots and the cloud provider where the snapshots are stored. 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.
snapshotIds string[]: Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
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: 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.
description str: UDescription of the snapshot. Only present for on-demand snapshots.
expires_at str: UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
id str: Unique identifier for the sharded cluster 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[GetCloudBackupSnapshotsResultMember]: Block of List of snapshots and the cloud provider where the snapshots are stored. 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_ids Sequence[str]: Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
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: 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.
description String: UDescription of the snapshot. Only present for on-demand snapshots.
expiresAt String: UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
id String: Unique identifier for the sharded cluster 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. 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.
snapshotIds List<String>: Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
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: queued, inProgress, completed, failed.
storageSizeBytes Number: Specifies the size of the snapshot in bytes.
type String: Specifies the type of cluster: replicaSet or shardedCluster.

GetCloudBackupSnapshotsResultMember

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.

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSnapshots

On this page

On this page

# Data Source: mongodbatlas.getCloudBackupSnapshots

Example Usage

Using getCloudBackupSnapshots

getCloudBackupSnapshots Result

Supporting Types

GetCloudBackupSnapshotsResult

GetCloudBackupSnapshotsResultMember

Package Details

On this page

On this page