MongoDB Atlas v3.7.1, Mar 10 23

mongodbatlas.getCloudProviderSnapshots

WARNING: This datasource is deprecated, use mongodbatlas.getCloudBackupSnapshots

mongodbatlas.getCloudProviderSnapshots 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!

package generated_program;

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

        final var testCloudProviderSnapshots = MongodbatlasFunctions.getCloudProviderSnapshots(GetCloudProviderSnapshotsArgs.builder()
            .groupId(mongodbatlas_cloud_provider_snapshots.test().group_id())
            .clusterName(mongodbatlas_cloud_provider_snapshots.test().cluster_name())
            .pageNum(1)
            .itemsPerPage(5)
            .build());

    }
}

Coming soon!

resources:
  testCloudProviderSnapshot:
    type: mongodbatlas:CloudProviderSnapshot
    properties:
      groupId: 5d0f1f73cf09a29120e173cf
      clusterName: MyClusterTest
      description: SomeDescription
      retentionInDays: 1
variables:
  testCloudProviderSnapshots:
    fn::invoke:
      Function: mongodbatlas:getCloudProviderSnapshots
      Arguments:
        groupId: ${mongodbatlas_cloud_provider_snapshots.test.group_id}
        clusterName: ${mongodbatlas_cloud_provider_snapshots.test.cluster_name}
        pageNum: 1
        itemsPerPage: 5

Using getCloudProviderSnapshots

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 getCloudProviderSnapshots(args: GetCloudProviderSnapshotsArgs, opts?: InvokeOptions): Promise<GetCloudProviderSnapshotsResult>
function getCloudProviderSnapshotsOutput(args: GetCloudProviderSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetCloudProviderSnapshotsResult>

def get_cloud_provider_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) -> GetCloudProviderSnapshotsResult
def get_cloud_provider_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[GetCloudProviderSnapshotsResult]

func LookupCloudProviderSnapshots(ctx *Context, args *LookupCloudProviderSnapshotsArgs, opts ...InvokeOption) (*LookupCloudProviderSnapshotsResult, error)
func LookupCloudProviderSnapshotsOutput(ctx *Context, args *LookupCloudProviderSnapshotsOutputArgs, opts ...InvokeOption) LookupCloudProviderSnapshotsResultOutput

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

public static class GetCloudProviderSnapshots 
{
    public static Task<GetCloudProviderSnapshotsResult> InvokeAsync(GetCloudProviderSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudProviderSnapshotsResult> Invoke(GetCloudProviderSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudProviderSnapshotsResult> getCloudProviderSnapshots(GetCloudProviderSnapshotsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getCloudProviderSnapshots:getCloudProviderSnapshots
  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.

getCloudProviderSnapshots Result

The following output properties are available:

ClusterName string
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetCloudProviderSnapshotsResult>: Includes cloudProviderSnapshot object for each item detailed in the results array section.
TotalCount int
ItemsPerPage int
PageNum int

ClusterName string
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetCloudProviderSnapshotsResult: Includes cloudProviderSnapshot object for each item detailed in the results array section.
TotalCount int
ItemsPerPage int
PageNum int

clusterName String
id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<GetCloudProviderSnapshotsResult>: Includes cloudProviderSnapshot object for each item detailed in the results array section.
totalCount Integer
itemsPerPage Integer
pageNum Integer

clusterName string
id string: The provider-assigned unique ID for this managed resource.
projectId string
results GetCloudProviderSnapshotsResult[]: Includes cloudProviderSnapshot object for each item detailed in the results array section.
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[GetCloudProviderSnapshotsResult]: Includes cloudProviderSnapshot object for each item detailed in the results array section.
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 Number
itemsPerPage Number
pageNum Number

Supporting Types

GetCloudProviderSnapshotsResult

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 of 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.
MongodVersion string: Version of the MongoDB server.
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.

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 of 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.
MongodVersion string: Version of the MongoDB server.
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.

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 of 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.
mongodVersion String: Version of the MongoDB server.
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.

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 of 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.
mongodVersion string: Version of the MongoDB server.
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.

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 of 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.
mongod_version str: Version of the MongoDB server.
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.

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 of 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.
mongodVersion String: Version of the MongoDB server.
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.

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.