Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

MongoDB Atlas

v3.0.1 published on Monday, Nov 1, 2021 by Pulumi

getCloudProviderSnapshot

mongodbatlas.CloudProviderSnapshot 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 getCloudProviderSnapshot

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 getCloudProviderSnapshot(args: GetCloudProviderSnapshotArgs, opts?: InvokeOptions): Promise<GetCloudProviderSnapshotResult>
function getCloudProviderSnapshotOutput(args: GetCloudProviderSnapshotOutputArgs, opts?: InvokeOptions): Output<GetCloudProviderSnapshotResult>
def get_cloud_provider_snapshot(cluster_name: Optional[str] = None,
                                project_id: Optional[str] = None,
                                snapshot_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetCloudProviderSnapshotResult
def get_cloud_provider_snapshot_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                project_id: Optional[pulumi.Input[str]] = None,
                                snapshot_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetCloudProviderSnapshotResult]
func LookupCloudProviderSnapshot(ctx *Context, args *LookupCloudProviderSnapshotArgs, opts ...InvokeOption) (*LookupCloudProviderSnapshotResult, error)
func LookupCloudProviderSnapshotOutput(ctx *Context, args *LookupCloudProviderSnapshotOutputArgs, opts ...InvokeOption) LookupCloudProviderSnapshotResultOutput

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

public static class GetCloudProviderSnapshot 
{
    public static Task<GetCloudProviderSnapshotResult> InvokeAsync(GetCloudProviderSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudProviderSnapshotResult> Invoke(GetCloudProviderSnapshotInvokeArgs 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
SnapshotId string
The unique identifier of the snapshot you want to retrieve.
ClusterName string
The name of the Atlas cluster that contains the snapshot you want to retrieve.
ProjectId string
SnapshotId string
The unique identifier of the snapshot you want to retrieve.
clusterName string
The name of the Atlas cluster that contains the snapshot you want to retrieve.
projectId string
snapshotId string
The unique identifier of the snapshot you want to retrieve.
cluster_name str
The name of the Atlas cluster that contains the snapshot you want to retrieve.
project_id str
snapshot_id str
The unique identifier of the snapshot you want to retrieve.

getCloudProviderSnapshot Result

The following output properties are available:

ClusterName string
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
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.
MongodVersion string
Version of the MongoDB server.
ProjectId string
SnapshotId string
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.
ClusterName string
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
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.
MongodVersion string
Version of the MongoDB server.
ProjectId string
SnapshotId string
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.
clusterName string
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
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.
mongodVersion string
Version of the MongoDB server.
projectId string
snapshotId string
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.
cluster_name str
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
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.
mongod_version str
Version of the MongoDB server.
project_id str
snapshot_id str
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.