Alibaba Cloud v3.45.0, Nov 27 23

Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi

alicloud.databasefilesystem.getSnapshots

Explore with Pulumi AI

Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi

pulumi/pulumi-alicloud

Example Usage

Basic Usage

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

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.DatabaseFilesystem.GetSnapshots.Invoke(new()
    {
        Ids = new[]
        {
            "example_id",
        },
    });

    var nameRegex = AliCloud.DatabaseFilesystem.GetSnapshots.Invoke(new()
    {
        NameRegex = "^my-Snapshot",
    });

    var status = AliCloud.DatabaseFilesystem.GetSnapshots.Invoke(new()
    {
        Status = "accomplished",
    });

    return new Dictionary<string, object?>
    {
        ["dbfsSnapshotId1"] = ids.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.Id),
        ["dbfsSnapshotId2"] = nameRegex.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.Id),
        ["dbfsSnapshotId3"] = status.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.Id),
    };
});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/databasefilesystem"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := databasefilesystem.GetSnapshots(ctx, &databasefilesystem.GetSnapshotsArgs{
			Ids: []string{
				"example_id",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dbfsSnapshotId1", ids.Snapshots[0].Id)
		nameRegex, err := databasefilesystem.GetSnapshots(ctx, &databasefilesystem.GetSnapshotsArgs{
			NameRegex: pulumi.StringRef("^my-Snapshot"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dbfsSnapshotId2", nameRegex.Snapshots[0].Id)
		status, err := databasefilesystem.GetSnapshots(ctx, &databasefilesystem.GetSnapshotsArgs{
			Status: pulumi.StringRef("accomplished"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dbfsSnapshotId3", status.Snapshots[0].Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.databasefilesystem.DatabasefilesystemFunctions;
import com.pulumi.alicloud.databasefilesystem.inputs.GetSnapshotsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var ids = DatabasefilesystemFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .ids("example_id")
            .build());

        ctx.export("dbfsSnapshotId1", ids.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].id()));
        final var nameRegex = DatabasefilesystemFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .nameRegex("^my-Snapshot")
            .build());

        ctx.export("dbfsSnapshotId2", nameRegex.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].id()));
        final var status = DatabasefilesystemFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .status("accomplished")
            .build());

        ctx.export("dbfsSnapshotId3", status.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].id()));
    }
}

import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.databasefilesystem.get_snapshots(ids=["example_id"])
pulumi.export("dbfsSnapshotId1", ids.snapshots[0].id)
name_regex = alicloud.databasefilesystem.get_snapshots(name_regex="^my-Snapshot")
pulumi.export("dbfsSnapshotId2", name_regex.snapshots[0].id)
status = alicloud.databasefilesystem.get_snapshots(status="accomplished")
pulumi.export("dbfsSnapshotId3", status.snapshots[0].id)

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

const ids = alicloud.databasefilesystem.getSnapshots({
    ids: ["example_id"],
});
export const dbfsSnapshotId1 = ids.then(ids => ids.snapshots?.[0]?.id);
const nameRegex = alicloud.databasefilesystem.getSnapshots({
    nameRegex: "^my-Snapshot",
});
export const dbfsSnapshotId2 = nameRegex.then(nameRegex => nameRegex.snapshots?.[0]?.id);
const status = alicloud.databasefilesystem.getSnapshots({
    status: "accomplished",
});
export const dbfsSnapshotId3 = status.then(status => status.snapshots?.[0]?.id);

variables:
  ids:
    fn::invoke:
      Function: alicloud:databasefilesystem:getSnapshots
      Arguments:
        ids:
          - example_id
  nameRegex:
    fn::invoke:
      Function: alicloud:databasefilesystem:getSnapshots
      Arguments:
        nameRegex: ^my-Snapshot
  status:
    fn::invoke:
      Function: alicloud:databasefilesystem:getSnapshots
      Arguments:
        status: accomplished
outputs:
  dbfsSnapshotId1: ${ids.snapshots[0].id}
  dbfsSnapshotId2: ${nameRegex.snapshots[0].id}
  dbfsSnapshotId3: ${status.snapshots[0].id}

Using getSnapshots

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 getSnapshots(args: GetSnapshotsArgs, opts?: InvokeOptions): Promise<GetSnapshotsResult>
function getSnapshotsOutput(args: GetSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetSnapshotsResult>

def get_snapshots(ids: Optional[Sequence[str]] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  status: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSnapshotsResult
def get_snapshots_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotsResult]

func GetSnapshots(ctx *Context, args *GetSnapshotsArgs, opts ...InvokeOption) (*GetSnapshotsResult, error)
func GetSnapshotsOutput(ctx *Context, args *GetSnapshotsOutputArgs, opts ...InvokeOption) GetSnapshotsResultOutput

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

public static class GetSnapshots 
{
    public static Task<GetSnapshotsResult> InvokeAsync(GetSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotsResult> Invoke(GetSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSnapshotsResult> getSnapshots(GetSnapshotsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:databasefilesystem/getSnapshots:getSnapshots
  arguments:
    # arguments dictionary

The following arguments are supported:

Ids List<string>: A list of Snapshot IDs.
NameRegex string: A regex string to filter results by Snapshot name.
OutputFile string: File name where to save data source results (after running pulumi preview).
Status string: The status of the snapshot. Possible values: progressing, accomplished, failed.

Ids []string: A list of Snapshot IDs.
NameRegex string: A regex string to filter results by Snapshot name.
OutputFile string: File name where to save data source results (after running pulumi preview).
Status string: The status of the snapshot. Possible values: progressing, accomplished, failed.

ids List<String>: A list of Snapshot IDs.
nameRegex String: A regex string to filter results by Snapshot name.
outputFile String: File name where to save data source results (after running pulumi preview).
status String: The status of the snapshot. Possible values: progressing, accomplished, failed.

ids string[]: A list of Snapshot IDs.
nameRegex string: A regex string to filter results by Snapshot name.
outputFile string: File name where to save data source results (after running pulumi preview).
status string: The status of the snapshot. Possible values: progressing, accomplished, failed.

ids Sequence[str]: A list of Snapshot IDs.
name_regex str: A regex string to filter results by Snapshot name.
output_file str: File name where to save data source results (after running pulumi preview).
status str: The status of the snapshot. Possible values: progressing, accomplished, failed.

ids List<String>: A list of Snapshot IDs.
nameRegex String: A regex string to filter results by Snapshot name.
outputFile String: File name where to save data source results (after running pulumi preview).
status String: The status of the snapshot. Possible values: progressing, accomplished, failed.

getSnapshots Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>
Names List<string>
Snapshots List<Pulumi.AliCloud.DatabaseFilesystem.Outputs.GetSnapshotsSnapshot>
NameRegex string
OutputFile string
Status string

Id string: The provider-assigned unique ID for this managed resource.
Ids []string
Names []string
Snapshots []GetSnapshotsSnapshot
NameRegex string
OutputFile string
Status string

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
snapshots List<GetSnapshotsSnapshot>
nameRegex String
outputFile String
status String

id string: The provider-assigned unique ID for this managed resource.
ids string[]
names string[]
snapshots GetSnapshotsSnapshot[]
nameRegex string
outputFile string
status string

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]
names Sequence[str]
snapshots Sequence[GetSnapshotsSnapshot]
name_regex str
output_file str
status str

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
snapshots List<Property Map>
nameRegex String
outputFile String
status String

Supporting Types

GetSnapshotsSnapshot

Category string: The type of the Snapshot.
CreateTime string: The creation time of the snapshot.
Description string: The description of the snapshot.
Id string: The ID of the Snapshot.
InstanceId string: The ID of the database file system.
LastModifiedTime string: The last modification time of the snapshot.
Progress string: The progress of the snapshot.
RemainTime int: The remaining completion time of the snapshot being created, in seconds.
RetentionDays int: The retention days of the snapshot.
SnapshotId string: The ID of the snapshot.
SnapshotName string: The name of the snapshot.
SnapshotType string: The creation of the snapshot.
SourceFsSize int: Source database file system capacity.
Status string: The status of the snapshot. Possible values: progressing, accomplished, failed.

Category string: The type of the Snapshot.
CreateTime string: The creation time of the snapshot.
Description string: The description of the snapshot.
Id string: The ID of the Snapshot.
InstanceId string: The ID of the database file system.
LastModifiedTime string: The last modification time of the snapshot.
Progress string: The progress of the snapshot.
RemainTime int: The remaining completion time of the snapshot being created, in seconds.
RetentionDays int: The retention days of the snapshot.
SnapshotId string: The ID of the snapshot.
SnapshotName string: The name of the snapshot.
SnapshotType string: The creation of the snapshot.
SourceFsSize int: Source database file system capacity.
Status string: The status of the snapshot. Possible values: progressing, accomplished, failed.

category String: The type of the Snapshot.
createTime String: The creation time of the snapshot.
description String: The description of the snapshot.
id String: The ID of the Snapshot.
instanceId String: The ID of the database file system.
lastModifiedTime String: The last modification time of the snapshot.
progress String: The progress of the snapshot.
remainTime Integer: The remaining completion time of the snapshot being created, in seconds.
retentionDays Integer: The retention days of the snapshot.
snapshotId String: The ID of the snapshot.
snapshotName String: The name of the snapshot.
snapshotType String: The creation of the snapshot.
sourceFsSize Integer: Source database file system capacity.
status String: The status of the snapshot. Possible values: progressing, accomplished, failed.

category string: The type of the Snapshot.
createTime string: The creation time of the snapshot.
description string: The description of the snapshot.
id string: The ID of the Snapshot.
instanceId string: The ID of the database file system.
lastModifiedTime string: The last modification time of the snapshot.
progress string: The progress of the snapshot.
remainTime number: The remaining completion time of the snapshot being created, in seconds.
retentionDays number: The retention days of the snapshot.
snapshotId string: The ID of the snapshot.
snapshotName string: The name of the snapshot.
snapshotType string: The creation of the snapshot.
sourceFsSize number: Source database file system capacity.
status string: The status of the snapshot. Possible values: progressing, accomplished, failed.

category str: The type of the Snapshot.
create_time str: The creation time of the snapshot.
description str: The description of the snapshot.
id str: The ID of the Snapshot.
instance_id str: The ID of the database file system.
last_modified_time str: The last modification time of the snapshot.
progress str: The progress of the snapshot.
remain_time int: The remaining completion time of the snapshot being created, in seconds.
retention_days int: The retention days of the snapshot.
snapshot_id str: The ID of the snapshot.
snapshot_name str: The name of the snapshot.
snapshot_type str: The creation of the snapshot.
source_fs_size int: Source database file system capacity.
status str: The status of the snapshot. Possible values: progressing, accomplished, failed.

category String: The type of the Snapshot.
createTime String: The creation time of the snapshot.
description String: The description of the snapshot.
id String: The ID of the Snapshot.
instanceId String: The ID of the database file system.
lastModifiedTime String: The last modification time of the snapshot.
progress String: The progress of the snapshot.
remainTime Number: The remaining completion time of the snapshot being created, in seconds.
retentionDays Number: The retention days of the snapshot.
snapshotId String: The ID of the snapshot.
snapshotName String: The name of the snapshot.
snapshotType String: The creation of the snapshot.
sourceFsSize Number: Source database file system capacity.
status String: The status of the snapshot. Possible values: progressing, accomplished, failed.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi

pulumi/pulumi-alicloud

alicloud.databasefilesystem.getSnapshots

On this page

On this page

Example Usage

Using getSnapshots

getSnapshots Result

Supporting Types

GetSnapshotsSnapshot

Package Details

On this page

On this page