MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.5.0 published on Wednesday, Jul 20, 2022 by Pulumi

getCloudBackupSnapshot

mongodbatlas.CloudBackupSnapshot 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 getCloudBackupSnapshot

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 getCloudBackupSnapshot(args: GetCloudBackupSnapshotArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotResult>
function getCloudBackupSnapshotOutput(args: GetCloudBackupSnapshotOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotResult>
def get_cloud_backup_snapshot(cluster_name: Optional[str] = None,
                              project_id: Optional[str] = None,
                              snapshot_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotResult
def get_cloud_backup_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[GetCloudBackupSnapshotResult]
func LookupCloudBackupSnapshot(ctx *Context, args *LookupCloudBackupSnapshotArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotResult, error)
func LookupCloudBackupSnapshotOutput(ctx *Context, args *LookupCloudBackupSnapshotOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotResultOutput

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

public static class GetCloudBackupSnapshot 
{
    public static Task<GetCloudBackupSnapshotResult> InvokeAsync(GetCloudBackupSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotResult> Invoke(GetCloudBackupSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCloudBackupSnapshotResult> getCloudBackupSnapshot(GetCloudBackupSnapshotArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getCloudBackupSnapshot:getCloudBackupSnapshot
  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
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.

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.

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.

getCloudBackupSnapshot Result

The following output properties are available:

CloudProvider string

Cloud provider that stores this snapshot.

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.

Members List<GetCloudBackupSnapshotMember>

Block of List of snapshots and the cloud provider where the snapshots are stored. See below

MongodVersion string

Version of the MongoDB server.

ProjectId string
ReplicaSetName string

Label given to a shard or config server from which Atlas took this snapshot.

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

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.

Members []GetCloudBackupSnapshotMember

Block of List of snapshots and the cloud provider where the snapshots are stored. See below

MongodVersion string

Version of the MongoDB server.

ProjectId string
ReplicaSetName string

Label given to a shard or config server from which Atlas took this snapshot.

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

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.

members List<GetCloudBackupSnapshotMember>

Block of List of snapshots and the cloud provider where the snapshots are stored. See below

mongodVersion String

Version of the MongoDB server.

projectId String
replicaSetName String

Label given to a shard or config server from which Atlas took this snapshot.

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

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.

members GetCloudBackupSnapshotMember[]

Block of List of snapshots and the cloud provider where the snapshots are stored. See below

mongodVersion string

Version of the MongoDB server.

projectId string
replicaSetName string

Label given to a shard or config server from which Atlas took this snapshot.

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

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.

members Sequence[GetCloudBackupSnapshotMember]

Block of List of snapshots and the cloud provider where the snapshots are stored. See below

mongod_version str

Version of the MongoDB server.

project_id str
replica_set_name str

Label given to a shard or config server from which Atlas took this snapshot.

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

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.

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.

projectId String
replicaSetName String

Label given to a shard or config server from which Atlas took this snapshot.

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

Supporting Types

GetCloudBackupSnapshotMember

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
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.