mongodbatlas.getCloudBackupSnapshot
Explore with Pulumi AI
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:
- Cluster
Name string The name of the Atlas cluster that contains the snapshot you want to retrieve.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Snapshot
Id string The unique identifier of the snapshot you want to retrieve.
- Cluster
Name string The name of the Atlas cluster that contains the snapshot you want to retrieve.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Snapshot
Id string The unique identifier of the snapshot you want to retrieve.
- cluster
Name String The name of the Atlas cluster that contains the snapshot you want to retrieve.
- project
Id String The unique identifier of the project for the Atlas cluster.
- snapshot
Id String The unique identifier of the snapshot you want to retrieve.
- cluster
Name string The name of the Atlas cluster that contains the snapshot you want to retrieve.
- project
Id string The unique identifier of the project for the Atlas cluster.
- snapshot
Id 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 The unique identifier of the project for the Atlas cluster.
- snapshot_
id str The unique identifier of the snapshot you want to retrieve.
- cluster
Name String The name of the Atlas cluster that contains the snapshot you want to retrieve.
- project
Id String The unique identifier of the project for the Atlas cluster.
- snapshot
Id String The unique identifier of the snapshot you want to retrieve.
getCloudBackupSnapshot Result
The following output properties are available:
- Cloud
Provider string Cloud provider that stores this snapshot.
- Cluster
Name string - Created
At 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.
- Expires
At 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.
- Master
Key stringUuid 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<Get
Cloud Backup Snapshot Member> Block of List of snapshots and the cloud provider where the snapshots are stored. See below
- Mongod
Version string Version of the MongoDB server.
- Project
Id string - Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Snapshot
Id string - Snapshot
Ids List<string> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
- Snapshot
Type 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.
- Storage
Size intBytes Specifies the size of the snapshot in bytes.
- Type string
Specifies the type of cluster: replicaSet or shardedCluster.
- Cloud
Provider string Cloud provider that stores this snapshot.
- Cluster
Name string - Created
At 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.
- Expires
At 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.
- Master
Key stringUuid 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
[]Get
Cloud Backup Snapshot Member Block of List of snapshots and the cloud provider where the snapshots are stored. See below
- Mongod
Version string Version of the MongoDB server.
- Project
Id string - Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Snapshot
Id string - Snapshot
Ids []string Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
- Snapshot
Type 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.
- Storage
Size intBytes Specifies the size of the snapshot in bytes.
- Type string
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider String Cloud provider that stores this snapshot.
- cluster
Name String - created
At 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.
- expires
At 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.
- master
Key StringUuid 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<Get
Cloud Backup Snapshot Member> Block of List of snapshots and the cloud provider where the snapshots are stored. See below
- mongod
Version String Version of the MongoDB server.
- project
Id String - replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- snapshot
Id String - snapshot
Ids List<String> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
- snapshot
Type 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.
- storage
Size IntegerBytes Specifies the size of the snapshot in bytes.
- type String
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider string Cloud provider that stores this snapshot.
- cluster
Name string - created
At 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.
- expires
At 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.
- master
Key stringUuid 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
Get
Cloud Backup Snapshot Member[] Block of List of snapshots and the cloud provider where the snapshots are stored. See below
- mongod
Version string Version of the MongoDB server.
- project
Id string - replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- snapshot
Id string - snapshot
Ids string[] Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
- snapshot
Type 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.
- storage
Size numberBytes 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_ struuid 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[Get
Cloud Backup Snapshot Member] 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_ strname 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_ intbytes Specifies the size of the snapshot in bytes.
- type str
Specifies the type of cluster: replicaSet or shardedCluster.
- cloud
Provider String Cloud provider that stores this snapshot.
- cluster
Name String - created
At 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.
- expires
At 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.
- master
Key StringUuid 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
- mongod
Version String Version of the MongoDB server.
- project
Id String - replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- snapshot
Id String - snapshot
Ids List<String> Unique identifiers of the snapshots created for the shards and config server for a sharded cluster.
- snapshot
Type 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.
- storage
Size NumberBytes Specifies the size of the snapshot in bytes.
- type String
Specifies the type of cluster: replicaSet or shardedCluster.
Supporting Types
GetCloudBackupSnapshotMember
- Cloud
Provider string Cloud provider that stores this snapshot.
- Id string
Unique identifier for the sharded cluster snapshot.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- Cloud
Provider string Cloud provider that stores this snapshot.
- Id string
Unique identifier for the sharded cluster snapshot.
- Replica
Set stringName Label given to a shard or config server from which Atlas took this snapshot.
- cloud
Provider String Cloud provider that stores this snapshot.
- id String
Unique identifier for the sharded cluster snapshot.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
- cloud
Provider string Cloud provider that stores this snapshot.
- id string
Unique identifier for the sharded cluster snapshot.
- replica
Set stringName 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_ strname Label given to a shard or config server from which Atlas took this snapshot.
- cloud
Provider String Cloud provider that stores this snapshot.
- id String
Unique identifier for the sharded cluster snapshot.
- replica
Set StringName Label given to a shard or config server from which Atlas took this snapshot.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.