Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. getCloudBackupSnapshotDatabases
Viewing docs for MongoDB Atlas v4.15.0
published on Friday, Aug 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSnapshotDatabases

mongodbatlas logo mongodbatlas logo
Viewing docs for MongoDB Atlas v4.15.0
published on Friday, Aug 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.getCloudBackupSnapshotDatabases describes the databases contained in a Cloud Backup snapshot. Use this data source to discover namespaces before creating a collection restore job. Point-in-time restores have no snapshot ID, so this data source does not apply to PIT restores.

    To use this data source, the requesting Service Account or API Key must have the Backup Manager or Project Owner role.

    Using getCloudBackupSnapshotDatabases

    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 getCloudBackupSnapshotDatabases(args: GetCloudBackupSnapshotDatabasesArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotDatabasesResult>
function getCloudBackupSnapshotDatabasesOutput(args: GetCloudBackupSnapshotDatabasesOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudBackupSnapshotDatabasesResult>
    def get_cloud_backup_snapshot_databases(cluster_name: Optional[str] = None,
                                        project_id: Optional[str] = None,
                                        snapshot_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotDatabasesResult
def get_cloud_backup_snapshot_databases_output(cluster_name: pulumi.Input[Optional[str]] = None,
                                        project_id: pulumi.Input[Optional[str]] = None,
                                        snapshot_id: pulumi.Input[Optional[str]] = None,
                                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudBackupSnapshotDatabasesResult]
    func LookupCloudBackupSnapshotDatabases(ctx *Context, args *LookupCloudBackupSnapshotDatabasesArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotDatabasesResult, error)
func LookupCloudBackupSnapshotDatabasesOutput(ctx *Context, args *LookupCloudBackupSnapshotDatabasesOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotDatabasesResultOutput

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

    public static class GetCloudBackupSnapshotDatabases 
{
    public static Task<GetCloudBackupSnapshotDatabasesResult> InvokeAsync(GetCloudBackupSnapshotDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotDatabasesResult> Invoke(GetCloudBackupSnapshotDatabasesInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotDatabasesResult> Invoke(GetCloudBackupSnapshotDatabasesInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudBackupSnapshotDatabasesResult> getCloudBackupSnapshotDatabases(GetCloudBackupSnapshotDatabasesArgs args, InvokeOptions options)
public static Output<GetCloudBackupSnapshotDatabasesResult> getCloudBackupSnapshotDatabases(GetCloudBackupSnapshotDatabasesArgs args, InvokeOptions options)
public static Output<GetCloudBackupSnapshotDatabasesResult> getCloudBackupSnapshotDatabases(GetCloudBackupSnapshotDatabasesArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: mongodbatlas:index/getCloudBackupSnapshotDatabases:getCloudBackupSnapshotDatabases
  arguments:
    # arguments dictionary
    data "mongodbatlas_get_cloud_backup_snapshot_databases" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterName string
    Human-readable label that identifies the cluster.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    ClusterName string
    Human-readable label that identifies the cluster.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    cluster_name string
    Human-readable label that identifies the cluster.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    snapshot_id string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    clusterName String
    Human-readable label that identifies the cluster.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    clusterName string
    Human-readable label that identifies the cluster.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    snapshotId string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    cluster_name str
    Human-readable label that identifies the cluster.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    snapshot_id str
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    clusterName String
    Human-readable label that identifies the cluster.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the desired snapshot.

    getCloudBackupSnapshotDatabases Result

    The following output properties are available:

    ClusterName string
    Human-readable label that identifies the cluster.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Results List<GetCloudBackupSnapshotDatabasesResult>
    List of returned documents that MongoDB Cloud provides when completing this request.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    ClusterName string
    Human-readable label that identifies the cluster.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Results []GetCloudBackupSnapshotDatabasesResult
    List of returned documents that MongoDB Cloud provides when completing this request.
    SnapshotId string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    cluster_name string
    Human-readable label that identifies the cluster.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results list(object)
    List of returned documents that MongoDB Cloud provides when completing this request.
    snapshot_id string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    clusterName String
    Human-readable label that identifies the cluster.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results List<GetCloudBackupSnapshotDatabasesResult>
    List of returned documents that MongoDB Cloud provides when completing this request.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    clusterName string
    Human-readable label that identifies the cluster.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results GetCloudBackupSnapshotDatabasesResult[]
    List of returned documents that MongoDB Cloud provides when completing this request.
    snapshotId string
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    cluster_name str
    Human-readable label that identifies the cluster.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results Sequence[GetCloudBackupSnapshotDatabasesResult]
    List of returned documents that MongoDB Cloud provides when completing this request.
    snapshot_id str
    Unique 24-hexadecimal digit string that identifies the desired snapshot.
    clusterName String
    Human-readable label that identifies the cluster.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results List<Property Map>
    List of returned documents that MongoDB Cloud provides when completing this request.
    snapshotId String
    Unique 24-hexadecimal digit string that identifies the desired snapshot.

    Supporting Types

    GetCloudBackupSnapshotDatabasesResult

    Name string
    Human-readable label that identifies the database within the snapshot.
    Name string
    Human-readable label that identifies the database within the snapshot.
    name string
    Human-readable label that identifies the database within the snapshot.
    name String
    Human-readable label that identifies the database within the snapshot.
    name string
    Human-readable label that identifies the database within the snapshot.
    name str
    Human-readable label that identifies the database within the snapshot.
    name String
    Human-readable label that identifies the database within the 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 mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.15.0
    published on Friday, Aug 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial