1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. filenas
  6. Snapshot
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.filenas.Snapshot

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    A snapshot is a backup method. Each snapshot is a backup of file storage at a specific point in time. If data is lost or a failure occurs, you can use snapshots to restore file storage and recover lost data

    Example Usage

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

const fileNASSnapshotDemo = new volcenginecc.filenas.Snapshot("FileNASSnapshotDemo", {
    fileSystemId: "enas-apse1a059****",
    snapshotName: "FileNASSnapshotDemo",
    description: "FileNASSnapshotDemo description",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

file_nas_snapshot_demo = volcenginecc.filenas.Snapshot("FileNASSnapshotDemo",
    file_system_id="enas-apse1a059****",
    snapshot_name="FileNASSnapshotDemo",
    description="FileNASSnapshotDemo description")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filenas.NewSnapshot(ctx, "FileNASSnapshotDemo", &filenas.SnapshotArgs{
			FileSystemId: pulumi.String("enas-apse1a059****"),
			SnapshotName: pulumi.String("FileNASSnapshotDemo"),
			Description:  pulumi.String("FileNASSnapshotDemo description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var fileNASSnapshotDemo = new Volcenginecc.Filenas.Snapshot("FileNASSnapshotDemo", new()
    {
        FileSystemId = "enas-apse1a059****",
        SnapshotName = "FileNASSnapshotDemo",
        Description = "FileNASSnapshotDemo description",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.filenas.Snapshot;
import com.volcengine.volcenginecc.filenas.SnapshotArgs;
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) {
        var fileNASSnapshotDemo = new Snapshot("fileNASSnapshotDemo", SnapshotArgs.builder()
            .fileSystemId("enas-apse1a059****")
            .snapshotName("FileNASSnapshotDemo")
            .description("FileNASSnapshotDemo description")
            .build());

    }
}

    resources:
  fileNASSnapshotDemo:
    type: volcenginecc:filenas:Snapshot
    name: FileNASSnapshotDemo
    properties:
      fileSystemId: enas-apse1a059****
      snapshotName: FileNASSnapshotDemo
      description: FileNASSnapshotDemo description

    Create Snapshot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);
    @overload
def Snapshot(resource_name: str,
             args: SnapshotArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Snapshot(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             file_system_id: Optional[str] = None,
             snapshot_name: Optional[str] = None,
             description: Optional[str] = None)
    func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)
    public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
    public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)

    type: volcenginecc:filenas:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var snapshotResource = new Volcenginecc.Filenas.Snapshot("snapshotResource", new()
{
    FileSystemId = "string",
    SnapshotName = "string",
    Description = "string",
});

    example, err := filenas.NewSnapshot(ctx, "snapshotResource", &filenas.SnapshotArgs{
	FileSystemId: pulumi.String("string"),
	SnapshotName: pulumi.String("string"),
	Description:  pulumi.String("string"),
})

    var snapshotResource = new com.volcengine.volcenginecc.filenas.Snapshot("snapshotResource", com.volcengine.volcenginecc.filenas.SnapshotArgs.builder()
    .fileSystemId("string")
    .snapshotName("string")
    .description("string")
    .build());

    snapshot_resource = volcenginecc.filenas.Snapshot("snapshotResource",
    file_system_id="string",
    snapshot_name="string",
    description="string")

    const snapshotResource = new volcenginecc.filenas.Snapshot("snapshotResource", {
    fileSystemId: "string",
    snapshotName: "string",
    description: "string",
});

    type: volcenginecc:filenas:Snapshot
properties:
    description: string
    fileSystemId: string
    snapshotName: string

    Snapshot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Snapshot resource accepts the following input properties:

    FileSystemId string
    File System ID
    SnapshotName string
    Snapshot Name
    Description string
    Snapshot Description
    FileSystemId string
    File System ID
    SnapshotName string
    Snapshot Name
    Description string
    Snapshot Description
    fileSystemId String
    File System ID
    snapshotName String
    Snapshot Name
    description String
    Snapshot Description
    fileSystemId string
    File System ID
    snapshotName string
    Snapshot Name
    description string
    Snapshot Description
    file_system_id str
    File System ID
    snapshot_name str
    Snapshot Name
    description str
    Snapshot Description
    fileSystemId String
    File System ID
    snapshotName String
    Snapshot Name
    description String
    Snapshot Description

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:

    CreatedTime string
    Snapshot Creation Time
    FileSystemName string
    File System Name
    Id string
    The provider-assigned unique ID for this managed resource.
    IsEncrypt bool
    Is encryption enabled. Currently only false is supported (not encrypted)
    Progress string
    Snapshot Creation Progress
    RetentionDays int
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    SnapshotId string
    Snapshot ID
    SnapshotType string
    Snapshot Type. Default is Manual (manual snapshot)
    SourceSize int
    File System Capacity (GiB)
    SourceVersion string
    File System Version
    Status string
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    ZoneId string
    Availability Zone ID
    CreatedTime string
    Snapshot Creation Time
    FileSystemName string
    File System Name
    Id string
    The provider-assigned unique ID for this managed resource.
    IsEncrypt bool
    Is encryption enabled. Currently only false is supported (not encrypted)
    Progress string
    Snapshot Creation Progress
    RetentionDays int
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    SnapshotId string
    Snapshot ID
    SnapshotType string
    Snapshot Type. Default is Manual (manual snapshot)
    SourceSize int
    File System Capacity (GiB)
    SourceVersion string
    File System Version
    Status string
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    ZoneId string
    Availability Zone ID
    createdTime String
    Snapshot Creation Time
    fileSystemName String
    File System Name
    id String
    The provider-assigned unique ID for this managed resource.
    isEncrypt Boolean
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress String
    Snapshot Creation Progress
    retentionDays Integer
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshotId String
    Snapshot ID
    snapshotType String
    Snapshot Type. Default is Manual (manual snapshot)
    sourceSize Integer
    File System Capacity (GiB)
    sourceVersion String
    File System Version
    status String
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zoneId String
    Availability Zone ID
    createdTime string
    Snapshot Creation Time
    fileSystemName string
    File System Name
    id string
    The provider-assigned unique ID for this managed resource.
    isEncrypt boolean
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress string
    Snapshot Creation Progress
    retentionDays number
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshotId string
    Snapshot ID
    snapshotType string
    Snapshot Type. Default is Manual (manual snapshot)
    sourceSize number
    File System Capacity (GiB)
    sourceVersion string
    File System Version
    status string
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zoneId string
    Availability Zone ID
    created_time str
    Snapshot Creation Time
    file_system_name str
    File System Name
    id str
    The provider-assigned unique ID for this managed resource.
    is_encrypt bool
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress str
    Snapshot Creation Progress
    retention_days int
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshot_id str
    Snapshot ID
    snapshot_type str
    Snapshot Type. Default is Manual (manual snapshot)
    source_size int
    File System Capacity (GiB)
    source_version str
    File System Version
    status str
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zone_id str
    Availability Zone ID
    createdTime String
    Snapshot Creation Time
    fileSystemName String
    File System Name
    id String
    The provider-assigned unique ID for this managed resource.
    isEncrypt Boolean
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress String
    Snapshot Creation Progress
    retentionDays Number
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshotId String
    Snapshot ID
    snapshotType String
    Snapshot Type. Default is Manual (manual snapshot)
    sourceSize Number
    File System Capacity (GiB)
    sourceVersion String
    File System Version
    status String
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zoneId String
    Availability Zone ID

    Look up Existing Snapshot Resource

    Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SnapshotState, opts?: CustomResourceOptions): Snapshot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        file_system_id: Optional[str] = None,
        file_system_name: Optional[str] = None,
        is_encrypt: Optional[bool] = None,
        progress: Optional[str] = None,
        retention_days: Optional[int] = None,
        snapshot_id: Optional[str] = None,
        snapshot_name: Optional[str] = None,
        snapshot_type: Optional[str] = None,
        source_size: Optional[int] = None,
        source_version: Optional[str] = None,
        status: Optional[str] = None,
        zone_id: Optional[str] = None) -> Snapshot
    func GetSnapshot(ctx *Context, name string, id IDInput, state *SnapshotState, opts ...ResourceOption) (*Snapshot, error)
    public static Snapshot Get(string name, Input<string> id, SnapshotState? state, CustomResourceOptions? opts = null)
    public static Snapshot get(String name, Output<String> id, SnapshotState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:filenas:Snapshot    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedTime string
    Snapshot Creation Time
    Description string
    Snapshot Description
    FileSystemId string
    File System ID
    FileSystemName string
    File System Name
    IsEncrypt bool
    Is encryption enabled. Currently only false is supported (not encrypted)
    Progress string
    Snapshot Creation Progress
    RetentionDays int
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    SnapshotId string
    Snapshot ID
    SnapshotName string
    Snapshot Name
    SnapshotType string
    Snapshot Type. Default is Manual (manual snapshot)
    SourceSize int
    File System Capacity (GiB)
    SourceVersion string
    File System Version
    Status string
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    ZoneId string
    Availability Zone ID
    CreatedTime string
    Snapshot Creation Time
    Description string
    Snapshot Description
    FileSystemId string
    File System ID
    FileSystemName string
    File System Name
    IsEncrypt bool
    Is encryption enabled. Currently only false is supported (not encrypted)
    Progress string
    Snapshot Creation Progress
    RetentionDays int
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    SnapshotId string
    Snapshot ID
    SnapshotName string
    Snapshot Name
    SnapshotType string
    Snapshot Type. Default is Manual (manual snapshot)
    SourceSize int
    File System Capacity (GiB)
    SourceVersion string
    File System Version
    Status string
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    ZoneId string
    Availability Zone ID
    createdTime String
    Snapshot Creation Time
    description String
    Snapshot Description
    fileSystemId String
    File System ID
    fileSystemName String
    File System Name
    isEncrypt Boolean
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress String
    Snapshot Creation Progress
    retentionDays Integer
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshotId String
    Snapshot ID
    snapshotName String
    Snapshot Name
    snapshotType String
    Snapshot Type. Default is Manual (manual snapshot)
    sourceSize Integer
    File System Capacity (GiB)
    sourceVersion String
    File System Version
    status String
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zoneId String
    Availability Zone ID
    createdTime string
    Snapshot Creation Time
    description string
    Snapshot Description
    fileSystemId string
    File System ID
    fileSystemName string
    File System Name
    isEncrypt boolean
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress string
    Snapshot Creation Progress
    retentionDays number
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshotId string
    Snapshot ID
    snapshotName string
    Snapshot Name
    snapshotType string
    Snapshot Type. Default is Manual (manual snapshot)
    sourceSize number
    File System Capacity (GiB)
    sourceVersion string
    File System Version
    status string
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zoneId string
    Availability Zone ID
    created_time str
    Snapshot Creation Time
    description str
    Snapshot Description
    file_system_id str
    File System ID
    file_system_name str
    File System Name
    is_encrypt bool
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress str
    Snapshot Creation Progress
    retention_days int
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshot_id str
    Snapshot ID
    snapshot_name str
    Snapshot Name
    snapshot_type str
    Snapshot Type. Default is Manual (manual snapshot)
    source_size int
    File System Capacity (GiB)
    source_version str
    File System Version
    status str
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zone_id str
    Availability Zone ID
    createdTime String
    Snapshot Creation Time
    description String
    Snapshot Description
    fileSystemId String
    File System ID
    fileSystemName String
    File System Name
    isEncrypt Boolean
    Is encryption enabled. Currently only false is supported (not encrypted)
    progress String
    Snapshot Creation Progress
    retentionDays Number
    Snapshot Retention Period. Default is 2147483647 (permanent retention)
    snapshotId String
    Snapshot ID
    snapshotName String
    Snapshot Name
    snapshotType String
    Snapshot Type. Default is Manual (manual snapshot)
    sourceSize Number
    File System Capacity (GiB)
    sourceVersion String
    File System Version
    status String
    Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed
    zoneId String
    Availability Zone ID

    Import

    $ pulumi import volcenginecc:filenas/snapshot:Snapshot example "snapshot_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.