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

volcenginecc.storageebs.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 file of cloud disk data at a specific point in time. When data is lost or a failure occurs, you can roll back cloud disk data using the snapshot to recover lost data.

    Example Usage

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

const storageEBSSnapshotDemo = new volcenginecc.storageebs.Snapshot("StorageEBSSnapshotDemo", {
    volumeId: "vol-3wt6pip1dy3qu*****",
    snapshotName: "StorageEBSSnapshotDemo",
    description: "StorageEBSSnapshotDemo description",
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

storage_ebs_snapshot_demo = volcenginecc.storageebs.Snapshot("StorageEBSSnapshotDemo",
    volume_id="vol-3wt6pip1dy3qu*****",
    snapshot_name="StorageEBSSnapshotDemo",
    description="StorageEBSSnapshotDemo description",
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storageebs.NewSnapshot(ctx, "StorageEBSSnapshotDemo", &storageebs.SnapshotArgs{
			VolumeId:     pulumi.String("vol-3wt6pip1dy3qu*****"),
			SnapshotName: pulumi.String("StorageEBSSnapshotDemo"),
			Description:  pulumi.String("StorageEBSSnapshotDemo description"),
			ProjectName:  pulumi.String("default"),
			Tags: storageebs.SnapshotTagArray{
				&storageebs.SnapshotTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		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 storageEBSSnapshotDemo = new Volcenginecc.Storageebs.Snapshot("StorageEBSSnapshotDemo", new()
    {
        VolumeId = "vol-3wt6pip1dy3qu*****",
        SnapshotName = "StorageEBSSnapshotDemo",
        Description = "StorageEBSSnapshotDemo description",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcenginecc.Storageebs.Inputs.SnapshotTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.storageebs.Snapshot;
import com.volcengine.volcenginecc.storageebs.SnapshotArgs;
import com.pulumi.volcenginecc.storageebs.inputs.SnapshotTagArgs;
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 storageEBSSnapshotDemo = new Snapshot("storageEBSSnapshotDemo", SnapshotArgs.builder()
            .volumeId("vol-3wt6pip1dy3qu*****")
            .snapshotName("StorageEBSSnapshotDemo")
            .description("StorageEBSSnapshotDemo description")
            .projectName("default")
            .tags(SnapshotTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  storageEBSSnapshotDemo:
    type: volcenginecc:storageebs:Snapshot
    name: StorageEBSSnapshotDemo
    properties:
      volumeId: vol-3wt6pip1dy3qu*****
      snapshotName: StorageEBSSnapshotDemo
      description: StorageEBSSnapshotDemo description
      projectName: default
      tags:
        - key: env
          value: test

    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,
             snapshot_name: Optional[str] = None,
             volume_id: Optional[str] = None,
             description: Optional[str] = None,
             project_name: Optional[str] = None,
             retention_days: Optional[int] = None,
             tags: Optional[Sequence[SnapshotTagArgs]] = 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:storageebs: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.

    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:

    SnapshotName string
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    VolumeId string
    Cloud disk ID associated with the snapshot.
    Description string
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    ProjectName string
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    RetentionDays int
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    Tags List<Volcengine.SnapshotTag>
    SnapshotName string
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    VolumeId string
    Cloud disk ID associated with the snapshot.
    Description string
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    ProjectName string
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    RetentionDays int
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    Tags []SnapshotTagArgs
    snapshotName String
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    volumeId String
    Cloud disk ID associated with the snapshot.
    description String
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    projectName String
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retentionDays Integer
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    tags List<SnapshotTag>
    snapshotName string
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    volumeId string
    Cloud disk ID associated with the snapshot.
    description string
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    projectName string
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retentionDays number
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    tags SnapshotTag[]
    snapshot_name str
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    volume_id str
    Cloud disk ID associated with the snapshot.
    description str
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    project_name str
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retention_days int
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    tags Sequence[SnapshotTagArgs]
    snapshotName String
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    volumeId String
    Cloud disk ID associated with the snapshot.
    description String
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    projectName String
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retentionDays Number
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    tags List<Property Map>

    Outputs

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

    CreationTime string
    Snapshot creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    Image ID
    InstantAccess bool
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    Progress int
    Snapshot dump progress.
    Shared bool
    Whether the snapshot is shared.
    SnapshotGroupId string
    Snapshot consistency group ID.
    SnapshotId string
    Snapshot ID.
    SnapshotType string
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    Status string
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    VolumeKind string
    Cloud disk category. Value options: system: system disk. data: data disk.
    VolumeName string
    Cloud disk name.
    VolumeSize int
    Cloud disk size, in GiB.
    VolumeStatus string
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    VolumeType string
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    ZoneId string
    Availability zone ID where the snapshot is located.
    CreationTime string
    Snapshot creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    Image ID
    InstantAccess bool
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    Progress int
    Snapshot dump progress.
    Shared bool
    Whether the snapshot is shared.
    SnapshotGroupId string
    Snapshot consistency group ID.
    SnapshotId string
    Snapshot ID.
    SnapshotType string
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    Status string
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    VolumeKind string
    Cloud disk category. Value options: system: system disk. data: data disk.
    VolumeName string
    Cloud disk name.
    VolumeSize int
    Cloud disk size, in GiB.
    VolumeStatus string
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    VolumeType string
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    ZoneId string
    Availability zone ID where the snapshot is located.
    creationTime String
    Snapshot creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    Image ID
    instantAccess Boolean
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress Integer
    Snapshot dump progress.
    shared Boolean
    Whether the snapshot is shared.
    snapshotGroupId String
    Snapshot consistency group ID.
    snapshotId String
    Snapshot ID.
    snapshotType String
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status String
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    volumeKind String
    Cloud disk category. Value options: system: system disk. data: data disk.
    volumeName String
    Cloud disk name.
    volumeSize Integer
    Cloud disk size, in GiB.
    volumeStatus String
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volumeType String
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zoneId String
    Availability zone ID where the snapshot is located.
    creationTime string
    Snapshot creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    Image ID
    instantAccess boolean
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress number
    Snapshot dump progress.
    shared boolean
    Whether the snapshot is shared.
    snapshotGroupId string
    Snapshot consistency group ID.
    snapshotId string
    Snapshot ID.
    snapshotType string
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status string
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    volumeKind string
    Cloud disk category. Value options: system: system disk. data: data disk.
    volumeName string
    Cloud disk name.
    volumeSize number
    Cloud disk size, in GiB.
    volumeStatus string
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volumeType string
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zoneId string
    Availability zone ID where the snapshot is located.
    creation_time str
    Snapshot creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    Image ID
    instant_access bool
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress int
    Snapshot dump progress.
    shared bool
    Whether the snapshot is shared.
    snapshot_group_id str
    Snapshot consistency group ID.
    snapshot_id str
    Snapshot ID.
    snapshot_type str
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status str
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    volume_kind str
    Cloud disk category. Value options: system: system disk. data: data disk.
    volume_name str
    Cloud disk name.
    volume_size int
    Cloud disk size, in GiB.
    volume_status str
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volume_type str
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zone_id str
    Availability zone ID where the snapshot is located.
    creationTime String
    Snapshot creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    Image ID
    instantAccess Boolean
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress Number
    Snapshot dump progress.
    shared Boolean
    Whether the snapshot is shared.
    snapshotGroupId String
    Snapshot consistency group ID.
    snapshotId String
    Snapshot ID.
    snapshotType String
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status String
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    volumeKind String
    Cloud disk category. Value options: system: system disk. data: data disk.
    volumeName String
    Cloud disk name.
    volumeSize Number
    Cloud disk size, in GiB.
    volumeStatus String
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volumeType String
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zoneId String
    Availability zone ID where the snapshot is located.

    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,
        creation_time: Optional[str] = None,
        description: Optional[str] = None,
        image_id: Optional[str] = None,
        instant_access: Optional[bool] = None,
        progress: Optional[int] = None,
        project_name: Optional[str] = None,
        retention_days: Optional[int] = None,
        shared: Optional[bool] = None,
        snapshot_group_id: Optional[str] = None,
        snapshot_id: Optional[str] = None,
        snapshot_name: Optional[str] = None,
        snapshot_type: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[SnapshotTagArgs]] = None,
        volume_id: Optional[str] = None,
        volume_kind: Optional[str] = None,
        volume_name: Optional[str] = None,
        volume_size: Optional[int] = None,
        volume_status: Optional[str] = None,
        volume_type: 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:storageebs: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:
    CreationTime string
    Snapshot creation time.
    Description string
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    ImageId string
    Image ID
    InstantAccess bool
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    Progress int
    Snapshot dump progress.
    ProjectName string
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    RetentionDays int
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    Shared bool
    Whether the snapshot is shared.
    SnapshotGroupId string
    Snapshot consistency group ID.
    SnapshotId string
    Snapshot ID.
    SnapshotName string
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    SnapshotType string
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    Status string
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    Tags List<Volcengine.SnapshotTag>
    VolumeId string
    Cloud disk ID associated with the snapshot.
    VolumeKind string
    Cloud disk category. Value options: system: system disk. data: data disk.
    VolumeName string
    Cloud disk name.
    VolumeSize int
    Cloud disk size, in GiB.
    VolumeStatus string
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    VolumeType string
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    ZoneId string
    Availability zone ID where the snapshot is located.
    CreationTime string
    Snapshot creation time.
    Description string
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    ImageId string
    Image ID
    InstantAccess bool
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    Progress int
    Snapshot dump progress.
    ProjectName string
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    RetentionDays int
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    Shared bool
    Whether the snapshot is shared.
    SnapshotGroupId string
    Snapshot consistency group ID.
    SnapshotId string
    Snapshot ID.
    SnapshotName string
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    SnapshotType string
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    Status string
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    Tags []SnapshotTagArgs
    VolumeId string
    Cloud disk ID associated with the snapshot.
    VolumeKind string
    Cloud disk category. Value options: system: system disk. data: data disk.
    VolumeName string
    Cloud disk name.
    VolumeSize int
    Cloud disk size, in GiB.
    VolumeStatus string
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    VolumeType string
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    ZoneId string
    Availability zone ID where the snapshot is located.
    creationTime String
    Snapshot creation time.
    description String
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    imageId String
    Image ID
    instantAccess Boolean
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress Integer
    Snapshot dump progress.
    projectName String
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retentionDays Integer
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    shared Boolean
    Whether the snapshot is shared.
    snapshotGroupId String
    Snapshot consistency group ID.
    snapshotId String
    Snapshot ID.
    snapshotName String
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    snapshotType String
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status String
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    tags List<SnapshotTag>
    volumeId String
    Cloud disk ID associated with the snapshot.
    volumeKind String
    Cloud disk category. Value options: system: system disk. data: data disk.
    volumeName String
    Cloud disk name.
    volumeSize Integer
    Cloud disk size, in GiB.
    volumeStatus String
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volumeType String
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zoneId String
    Availability zone ID where the snapshot is located.
    creationTime string
    Snapshot creation time.
    description string
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    imageId string
    Image ID
    instantAccess boolean
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress number
    Snapshot dump progress.
    projectName string
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retentionDays number
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    shared boolean
    Whether the snapshot is shared.
    snapshotGroupId string
    Snapshot consistency group ID.
    snapshotId string
    Snapshot ID.
    snapshotName string
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    snapshotType string
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status string
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    tags SnapshotTag[]
    volumeId string
    Cloud disk ID associated with the snapshot.
    volumeKind string
    Cloud disk category. Value options: system: system disk. data: data disk.
    volumeName string
    Cloud disk name.
    volumeSize number
    Cloud disk size, in GiB.
    volumeStatus string
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volumeType string
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zoneId string
    Availability zone ID where the snapshot is located.
    creation_time str
    Snapshot creation time.
    description str
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    image_id str
    Image ID
    instant_access bool
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress int
    Snapshot dump progress.
    project_name str
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retention_days int
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    shared bool
    Whether the snapshot is shared.
    snapshot_group_id str
    Snapshot consistency group ID.
    snapshot_id str
    Snapshot ID.
    snapshot_name str
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    snapshot_type str
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status str
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    tags Sequence[SnapshotTagArgs]
    volume_id str
    Cloud disk ID associated with the snapshot.
    volume_kind str
    Cloud disk category. Value options: system: system disk. data: data disk.
    volume_name str
    Cloud disk name.
    volume_size int
    Cloud disk size, in GiB.
    volume_status str
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volume_type str
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zone_id str
    Availability zone ID where the snapshot is located.
    creationTime String
    Snapshot creation time.
    description String
    Snapshot description. Default is empty. Length must be between 0 and 255 characters.
    imageId String
    Image ID
    instantAccess Boolean
    Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
    progress Number
    Snapshot dump progress.
    projectName String
    Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
    retentionDays Number
    Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
    shared Boolean
    Whether the snapshot is shared.
    snapshotGroupId String
    Snapshot consistency group ID.
    snapshotId String
    Snapshot ID.
    snapshotName String
    Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
    snapshotType String
    Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
    status String
    Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
    tags List<Property Map>
    volumeId String
    Cloud disk ID associated with the snapshot.
    volumeKind String
    Cloud disk category. Value options: system: system disk. data: data disk.
    volumeName String
    Cloud disk name.
    volumeSize Number
    Cloud disk size, in GiB.
    volumeStatus String
    Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
    volumeType String
    Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
    zoneId String
    Availability zone ID where the snapshot is located.

    Supporting Types

    SnapshotTag, SnapshotTagArgs

    Key string
    User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
    Value string
    User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
    Key string
    User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
    Value string
    User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
    key String
    User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
    value String
    User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
    key string
    User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
    value string
    User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
    key str
    User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
    value str
    User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.
    key String
    User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
    value String
    User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

    Import

    $ pulumi import volcenginecc:storageebs/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.