MongoDB Atlas v3.30.0, Mar 21 25

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

mongodbatlas.getFlexSnapshot

Explore with Pulumi AI

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

pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.getFlexSnapshot

mongodbatlas.getFlexSnapshot describes a flex snapshot.

Example Usage

S

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 getFlexSnapshot

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 getFlexSnapshot(args: GetFlexSnapshotArgs, opts?: InvokeOptions): Promise<GetFlexSnapshotResult>
function getFlexSnapshotOutput(args: GetFlexSnapshotOutputArgs, opts?: InvokeOptions): Output<GetFlexSnapshotResult>

def get_flex_snapshot(name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      snapshot_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetFlexSnapshotResult
def get_flex_snapshot_output(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[GetFlexSnapshotResult]

func GetFlexSnapshot(ctx *Context, args *GetFlexSnapshotArgs, opts ...InvokeOption) (*GetFlexSnapshotResult, error)
func GetFlexSnapshotOutput(ctx *Context, args *GetFlexSnapshotOutputArgs, opts ...InvokeOption) GetFlexSnapshotResultOutput

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

public static class GetFlexSnapshot 
{
    public static Task<GetFlexSnapshotResult> InvokeAsync(GetFlexSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetFlexSnapshotResult> Invoke(GetFlexSnapshotInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFlexSnapshotResult> getFlexSnapshot(GetFlexSnapshotArgs args, InvokeOptions options)
public static Output<GetFlexSnapshotResult> getFlexSnapshot(GetFlexSnapshotArgs args, InvokeOptions options)

fn::invoke:
  function: mongodbatlas:index/getFlexSnapshot:getFlexSnapshot
  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.
SnapshotId string

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

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

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

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

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

getFlexSnapshot Result

The following output properties are available:

Expiration string
FinishTime string
Id string: The provider-assigned unique ID for this managed resource.
MongoDbVersion string
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
SnapshotId string
StartTime string
Status string

Expiration string
FinishTime string
Id string: The provider-assigned unique ID for this managed resource.
MongoDbVersion string
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
SnapshotId string
StartTime string
Status string

expiration String
finishTime String
id String: The provider-assigned unique ID for this managed resource.
mongoDbVersion String
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
snapshotId String
startTime String
status String

expiration string
finishTime string
id string: The provider-assigned unique ID for this managed resource.
mongoDbVersion string
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
snapshotId string
startTime string
status string

expiration str
finish_time str
id str: The provider-assigned unique ID for this managed resource.
mongo_db_version str
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
snapshot_id str
start_time str
status str

expiration String
finishTime String
id String: The provider-assigned unique ID for this managed resource.
mongoDbVersion String
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
snapshotId String
startTime String
status String

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

On this page

On this page

# Data Source: mongodbatlas.getFlexSnapshot

Example Usage

S

Using getFlexSnapshot

getFlexSnapshot Result

Package Details

On this page

On this page