MongoDB Atlas v3.30.0, Mar 21 25

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getFlexSnapshots

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.getFlexSnapshots

mongodbatlas.getFlexSnapshots returns all snapshots of a flex cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const snapshot = mongodbatlas.getFlexSnapshot({
    projectId: projectId,
    name: example_cluster.name,
    snapshotId: snapshotId,
});
const snapshots = mongodbatlas.getFlexSnapshots({
    projectId: projectId,
    name: example_cluster.name,
});
export const mongodbatlasFlexSnapshot = snapshot.then(snapshot => snapshot.name);
export const mongodbatlasFlexSnapshots = snapshots.then(snapshots => .map(snapshot => (snapshot.snapshotId)));

import pulumi
import pulumi_mongodbatlas as mongodbatlas

snapshot = mongodbatlas.get_flex_snapshot(project_id=project_id,
    name=example_cluster["name"],
    snapshot_id=snapshot_id)
snapshots = mongodbatlas.get_flex_snapshots(project_id=project_id,
    name=example_cluster["name"])
pulumi.export("mongodbatlasFlexSnapshot", snapshot.name)
pulumi.export("mongodbatlasFlexSnapshots", [snapshot.snapshot_id for snapshot in snapshots.results])

Coming soon!

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var snapshot = Mongodbatlas.GetFlexSnapshot.Invoke(new()
    {
        ProjectId = projectId,
        Name = example_cluster.Name,
        SnapshotId = snapshotId,
    });

    var snapshots = Mongodbatlas.GetFlexSnapshots.Invoke(new()
    {
        ProjectId = projectId,
        Name = example_cluster.Name,
    });

    return new Dictionary<string, object?>
    {
        ["mongodbatlasFlexSnapshot"] = snapshot.Apply(getFlexSnapshotResult => getFlexSnapshotResult.Name),
        ["mongodbatlasFlexSnapshots"] = .Select(snapshot => 
        {
            return snapshot.Apply(getFlexSnapshotResult => getFlexSnapshotResult.SnapshotId);
        }).ToList(),
    };
});

Coming soon!

Coming soon!

Using getFlexSnapshots

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.

TypeScript
Python
Go
C#
Java
YAML

function getFlexSnapshots(args: GetFlexSnapshotsArgs, opts?: InvokeOptions): Promise<GetFlexSnapshotsResult>
function getFlexSnapshotsOutput(args: GetFlexSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetFlexSnapshotsResult>

def get_flex_snapshots(name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFlexSnapshotsResult
def get_flex_snapshots_output(name: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFlexSnapshotsResult]

func LookupFlexSnapshots(ctx *Context, args *LookupFlexSnapshotsArgs, opts ...InvokeOption) (*LookupFlexSnapshotsResult, error)
func LookupFlexSnapshotsOutput(ctx *Context, args *LookupFlexSnapshotsOutputArgs, opts ...InvokeOption) LookupFlexSnapshotsResultOutput

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

public static class GetFlexSnapshots 
{
    public static Task<GetFlexSnapshotsResult> InvokeAsync(GetFlexSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetFlexSnapshotsResult> Invoke(GetFlexSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFlexSnapshotsResult> getFlexSnapshots(GetFlexSnapshotsArgs args, InvokeOptions options)
public static Output<GetFlexSnapshotsResult> getFlexSnapshots(GetFlexSnapshotsArgs args, InvokeOptions options)

fn::invoke:
  function: mongodbatlas:index/getFlexSnapshots:getFlexSnapshots
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

Name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

name String: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId String: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

name str: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
project_id str: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

name String: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId String: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

getFlexSnapshots Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
Results List<GetFlexSnapshotsResult>

Id string: The provider-assigned unique ID for this managed resource.
Name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
Results []GetFlexSnapshotsResult

id String: The provider-assigned unique ID for this managed resource.
name String: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId String: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
results List<GetFlexSnapshotsResult>

id string: The provider-assigned unique ID for this managed resource.
name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
results GetFlexSnapshotsResult[]

id str: The provider-assigned unique ID for this managed resource.
name str: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
project_id str: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
results Sequence[GetFlexSnapshotsResult]

id String: The provider-assigned unique ID for this managed resource.
name String: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId String: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
results List<Property Map>

Supporting Types

GetFlexSnapshotsResult

Expiration string: Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
FinishTime string: Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
MongoDbVersion string: MongoDB host version that the snapshot runs.
Name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
ScheduledTime string: Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
SnapshotId string: Unique 24-hexadecimal digit string that identifies the snapshot to restore.
StartTime string: Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Status string: Phase of the restore workflow for this job at the time this resource made this request.

Expiration string: Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
FinishTime string: Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
MongoDbVersion string: MongoDB host version that the snapshot runs.
Name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
ScheduledTime string: Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
SnapshotId string: Unique 24-hexadecimal digit string that identifies the snapshot to restore.
StartTime string: Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Status string: Phase of the restore workflow for this job at the time this resource made this request.

expiration String: Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
finishTime String: Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
mongoDbVersion String: MongoDB host version that the snapshot runs.
name String: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId String: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
scheduledTime String: Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
snapshotId String: Unique 24-hexadecimal digit string that identifies the snapshot to restore.
startTime String: Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
status String: Phase of the restore workflow for this job at the time this resource made this request.

expiration string: Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
finishTime string: Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
mongoDbVersion string: MongoDB host version that the snapshot runs.
name string: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId string: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
scheduledTime string: Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
snapshotId string: Unique 24-hexadecimal digit string that identifies the snapshot to restore.
startTime string: Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
status string: Phase of the restore workflow for this job at the time this resource made this request.

expiration str: Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
finish_time str: Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
mongo_db_version str: MongoDB host version that the snapshot runs.
name str: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
project_id str: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
scheduled_time str: Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
snapshot_id str: Unique 24-hexadecimal digit string that identifies the snapshot to restore.
start_time str: Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
status str: Phase of the restore workflow for this job at the time this resource made this request.

expiration String: Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
finishTime String: Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
mongoDbVersion String: MongoDB host version that the snapshot runs.
name String: Human-readable label that identifies the flex cluster whose snapshot you want to restore.
projectId String: Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
scheduledTime String: Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
snapshotId String: Unique 24-hexadecimal digit string that identifies the snapshot to restore.
startTime String: Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
status String: Phase of the restore workflow for this job at the time this resource made this request.

Package Details

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

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getFlexSnapshots

On this page

On this page

# Data Source: mongodbatlas.getFlexSnapshots

Example Usage

S

Using getFlexSnapshots

getFlexSnapshots Result

Supporting Types

GetFlexSnapshotsResult

Package Details

On this page

On this page