1. Packages
  2. Volcengine
  3. API Docs
  4. nas
  5. Snapshots
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.nas.Snapshots

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

Use this data source to query detailed information of nas snapshots

Example Usage

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

const default = volcengine.nas.Snapshots({
    fileSystemId: "enas-cnbj5c18f02afe0e",
    ids: [
        "snap-022c648fed8b",
        "snap-e53591b05fbd",
    ],
});
Copy
import pulumi
import pulumi_volcengine as volcengine

default = volcengine.nas.snapshots(file_system_id="enas-cnbj5c18f02afe0e",
    ids=[
        "snap-022c648fed8b",
        "snap-e53591b05fbd",
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/nas"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nas.Snapshots(ctx, &nas.SnapshotsArgs{
			FileSystemId: pulumi.StringRef("enas-cnbj5c18f02afe0e"),
			Ids: []string{
				"snap-022c648fed8b",
				"snap-e53591b05fbd",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Nas.Snapshots.Invoke(new()
    {
        FileSystemId = "enas-cnbj5c18f02afe0e",
        Ids = new[]
        {
            "snap-022c648fed8b",
            "snap-e53591b05fbd",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.nas.NasFunctions;
import com.pulumi.volcengine.nas.inputs.SnapshotsArgs;
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 default = NasFunctions.Snapshots(SnapshotsArgs.builder()
            .fileSystemId("enas-cnbj5c18f02afe0e")
            .ids(            
                "snap-022c648fed8b",
                "snap-e53591b05fbd")
            .build());

    }
}
Copy
variables:
  default:
    fn::invoke:
      Function: volcengine:nas:Snapshots
      Arguments:
        fileSystemId: enas-cnbj5c18f02afe0e
        ids:
          - snap-022c648fed8b
          - snap-e53591b05fbd
Copy

Using Snapshots

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 snapshots(args: SnapshotsArgs, opts?: InvokeOptions): Promise<SnapshotsResult>
function snapshotsOutput(args: SnapshotsOutputArgs, opts?: InvokeOptions): Output<SnapshotsResult>
Copy
def snapshots(file_system_id: Optional[str] = None,
              ids: Optional[Sequence[str]] = None,
              output_file: Optional[str] = None,
              snapshot_name: Optional[str] = None,
              snapshot_type: Optional[str] = None,
              status: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> SnapshotsResult
def snapshots_output(file_system_id: Optional[pulumi.Input[str]] = None,
              ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              snapshot_name: Optional[pulumi.Input[str]] = None,
              snapshot_type: Optional[pulumi.Input[str]] = None,
              status: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[SnapshotsResult]
Copy
func Snapshots(ctx *Context, args *SnapshotsArgs, opts ...InvokeOption) (*SnapshotsResult, error)
func SnapshotsOutput(ctx *Context, args *SnapshotsOutputArgs, opts ...InvokeOption) SnapshotsResultOutput
Copy
public static class Snapshots 
{
    public static Task<SnapshotsResult> InvokeAsync(SnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<SnapshotsResult> Invoke(SnapshotsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<SnapshotsResult> snapshots(SnapshotsArgs args, InvokeOptions options)
public static Output<SnapshotsResult> snapshots(SnapshotsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: volcengine:nas:Snapshots
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FileSystemId string
The ID of file system.
Ids List<string>
A list of Snapshot IDs.
OutputFile string
File name where to save data source results.
SnapshotName string
The name of snapshot.
SnapshotType string
The type of snapshot.
Status string
The status of snapshot.
FileSystemId string
The ID of file system.
Ids []string
A list of Snapshot IDs.
OutputFile string
File name where to save data source results.
SnapshotName string
The name of snapshot.
SnapshotType string
The type of snapshot.
Status string
The status of snapshot.
fileSystemId String
The ID of file system.
ids List<String>
A list of Snapshot IDs.
outputFile String
File name where to save data source results.
snapshotName String
The name of snapshot.
snapshotType String
The type of snapshot.
status String
The status of snapshot.
fileSystemId string
The ID of file system.
ids string[]
A list of Snapshot IDs.
outputFile string
File name where to save data source results.
snapshotName string
The name of snapshot.
snapshotType string
The type of snapshot.
status string
The status of snapshot.
file_system_id str
The ID of file system.
ids Sequence[str]
A list of Snapshot IDs.
output_file str
File name where to save data source results.
snapshot_name str
The name of snapshot.
snapshot_type str
The type of snapshot.
status str
The status of snapshot.
fileSystemId String
The ID of file system.
ids List<String>
A list of Snapshot IDs.
outputFile String
File name where to save data source results.
snapshotName String
The name of snapshot.
snapshotType String
The type of snapshot.
status String
The status of snapshot.

Snapshots Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Snapshots List<SnapshotsSnapshot>
The collection of query.
TotalCount int
The total count of query.
FileSystemId string
The id of file system.
Ids List<string>
OutputFile string
SnapshotName string
The name of snapshot.
SnapshotType string
The type of snapshot.
Status string
The status of snapshot.
Id string
The provider-assigned unique ID for this managed resource.
Snapshots []SnapshotsSnapshot
The collection of query.
TotalCount int
The total count of query.
FileSystemId string
The id of file system.
Ids []string
OutputFile string
SnapshotName string
The name of snapshot.
SnapshotType string
The type of snapshot.
Status string
The status of snapshot.
id String
The provider-assigned unique ID for this managed resource.
snapshots List<SnapshotsSnapshot>
The collection of query.
totalCount Integer
The total count of query.
fileSystemId String
The id of file system.
ids List<String>
outputFile String
snapshotName String
The name of snapshot.
snapshotType String
The type of snapshot.
status String
The status of snapshot.
id string
The provider-assigned unique ID for this managed resource.
snapshots SnapshotsSnapshot[]
The collection of query.
totalCount number
The total count of query.
fileSystemId string
The id of file system.
ids string[]
outputFile string
snapshotName string
The name of snapshot.
snapshotType string
The type of snapshot.
status string
The status of snapshot.
id str
The provider-assigned unique ID for this managed resource.
snapshots Sequence[SnapshotsSnapshot]
The collection of query.
total_count int
The total count of query.
file_system_id str
The id of file system.
ids Sequence[str]
output_file str
snapshot_name str
The name of snapshot.
snapshot_type str
The type of snapshot.
status str
The status of snapshot.
id String
The provider-assigned unique ID for this managed resource.
snapshots List<Property Map>
The collection of query.
totalCount Number
The total count of query.
fileSystemId String
The id of file system.
ids List<String>
outputFile String
snapshotName String
The name of snapshot.
snapshotType String
The type of snapshot.
status String
The status of snapshot.

Supporting Types

SnapshotsSnapshot

CreateTime This property is required. string
The create time of snapshot.
Description This property is required. string
The description of snapshot.
FileSystemId This property is required. string
The ID of file system.
FileSystemName This property is required. string
The name of file system.
Id This property is required. string
The ID of snapshot.
IsEncrypt This property is required. bool
Whether is encrypt.
Progress This property is required. string
The progress of snapshot.
RetentionDays This property is required. int
The retention days of snapshot.
SnapshotId This property is required. string
The ID of snapshot.
SnapshotName This property is required. string
The name of snapshot.
SnapshotType This property is required. string
The type of snapshot.
SourceSize This property is required. int
The size of source.
SourceVersion This property is required. string
The source version info.
Status This property is required. string
The status of snapshot.
ZoneId This property is required. string
The ID of zone.
CreateTime This property is required. string
The create time of snapshot.
Description This property is required. string
The description of snapshot.
FileSystemId This property is required. string
The ID of file system.
FileSystemName This property is required. string
The name of file system.
Id This property is required. string
The ID of snapshot.
IsEncrypt This property is required. bool
Whether is encrypt.
Progress This property is required. string
The progress of snapshot.
RetentionDays This property is required. int
The retention days of snapshot.
SnapshotId This property is required. string
The ID of snapshot.
SnapshotName This property is required. string
The name of snapshot.
SnapshotType This property is required. string
The type of snapshot.
SourceSize This property is required. int
The size of source.
SourceVersion This property is required. string
The source version info.
Status This property is required. string
The status of snapshot.
ZoneId This property is required. string
The ID of zone.
createTime This property is required. String
The create time of snapshot.
description This property is required. String
The description of snapshot.
fileSystemId This property is required. String
The ID of file system.
fileSystemName This property is required. String
The name of file system.
id This property is required. String
The ID of snapshot.
isEncrypt This property is required. Boolean
Whether is encrypt.
progress This property is required. String
The progress of snapshot.
retentionDays This property is required. Integer
The retention days of snapshot.
snapshotId This property is required. String
The ID of snapshot.
snapshotName This property is required. String
The name of snapshot.
snapshotType This property is required. String
The type of snapshot.
sourceSize This property is required. Integer
The size of source.
sourceVersion This property is required. String
The source version info.
status This property is required. String
The status of snapshot.
zoneId This property is required. String
The ID of zone.
createTime This property is required. string
The create time of snapshot.
description This property is required. string
The description of snapshot.
fileSystemId This property is required. string
The ID of file system.
fileSystemName This property is required. string
The name of file system.
id This property is required. string
The ID of snapshot.
isEncrypt This property is required. boolean
Whether is encrypt.
progress This property is required. string
The progress of snapshot.
retentionDays This property is required. number
The retention days of snapshot.
snapshotId This property is required. string
The ID of snapshot.
snapshotName This property is required. string
The name of snapshot.
snapshotType This property is required. string
The type of snapshot.
sourceSize This property is required. number
The size of source.
sourceVersion This property is required. string
The source version info.
status This property is required. string
The status of snapshot.
zoneId This property is required. string
The ID of zone.
create_time This property is required. str
The create time of snapshot.
description This property is required. str
The description of snapshot.
file_system_id This property is required. str
The ID of file system.
file_system_name This property is required. str
The name of file system.
id This property is required. str
The ID of snapshot.
is_encrypt This property is required. bool
Whether is encrypt.
progress This property is required. str
The progress of snapshot.
retention_days This property is required. int
The retention days of snapshot.
snapshot_id This property is required. str
The ID of snapshot.
snapshot_name This property is required. str
The name of snapshot.
snapshot_type This property is required. str
The type of snapshot.
source_size This property is required. int
The size of source.
source_version This property is required. str
The source version info.
status This property is required. str
The status of snapshot.
zone_id This property is required. str
The ID of zone.
createTime This property is required. String
The create time of snapshot.
description This property is required. String
The description of snapshot.
fileSystemId This property is required. String
The ID of file system.
fileSystemName This property is required. String
The name of file system.
id This property is required. String
The ID of snapshot.
isEncrypt This property is required. Boolean
Whether is encrypt.
progress This property is required. String
The progress of snapshot.
retentionDays This property is required. Number
The retention days of snapshot.
snapshotId This property is required. String
The ID of snapshot.
snapshotName This property is required. String
The name of snapshot.
snapshotType This property is required. String
The type of snapshot.
sourceSize This property is required. Number
The size of source.
sourceVersion This property is required. String
The source version info.
status This property is required. String
The status of snapshot.
zoneId This property is required. String
The ID of zone.

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine