Get started with Pulumi in a free one hour introductory workshop. Register Now

GetCloudProviderSnapshots

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.

Using GetCloudProviderSnapshots

function getCloudProviderSnapshots(args: GetCloudProviderSnapshotsArgs, opts?: InvokeOptions): Promise<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
func GetCloudProviderSnapshots(ctx *Context, args *GetCloudProviderSnapshotsArgs, opts ...InvokeOption) (*GetCloudProviderSnapshotsResult, error)
public static class GetCloudProviderSnapshots {
    public static Task<GetCloudProviderSnapshotsResult> InvokeAsync(GetCloudProviderSnapshotsArgs args, InvokeOptions? opts = null)
}

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

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

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

Supporting Types

GetCloudProviderSnapshotsResult

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

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

Package Details

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