1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. storageebs
  5. Snapshot
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.storageebs.Snapshot

bytepluscc logo
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    快照是一种备份方式，每个快照都是云盘数据在某个时间点的备份文件。当数据丢失或故障时，您可以通过快照回滚云盘数据，找回丢失的数据。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

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

    import pulumi
import pulumi_bytepluscc as bytepluscc

storage_ebs_snapshot_demo = bytepluscc.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/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/storageebs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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 Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var storageEBSSnapshotDemo = new Bytepluscc.Storageebs.Snapshot("StorageEBSSnapshotDemo", new()
    {
        VolumeId = "vol-3wt6pip1dy3qu*****",
        SnapshotName = "StorageEBSSnapshotDemo",
        Description = "StorageEBSSnapshotDemo description",
        ProjectName = "default",
        Tags = new[]
        {
            new Bytepluscc.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.byteplus.bytepluscc.storageebs.Snapshot;
import com.byteplus.bytepluscc.storageebs.SnapshotArgs;
import com.pulumi.bytepluscc.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: bytepluscc: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: bytepluscc: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.

    Constructor example

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

    var byteplusccSnapshotResource = new Bytepluscc.Storageebs.Snapshot("byteplusccSnapshotResource", new()
{
    SnapshotName = "string",
    VolumeId = "string",
    Description = "string",
    ProjectName = "string",
    RetentionDays = 0,
    Tags = new[]
    {
        new Bytepluscc.Storageebs.Inputs.SnapshotTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := storageebs.NewSnapshot(ctx, "byteplusccSnapshotResource", &storageebs.SnapshotArgs{
	SnapshotName:  pulumi.String("string"),
	VolumeId:      pulumi.String("string"),
	Description:   pulumi.String("string"),
	ProjectName:   pulumi.String("string"),
	RetentionDays: pulumi.Int(0),
	Tags: storageebs.SnapshotTagArray{
		&storageebs.SnapshotTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var byteplusccSnapshotResource = new com.byteplus.bytepluscc.storageebs.Snapshot("byteplusccSnapshotResource", com.byteplus.bytepluscc.storageebs.SnapshotArgs.builder()
    .snapshotName("string")
    .volumeId("string")
    .description("string")
    .projectName("string")
    .retentionDays(0)
    .tags(SnapshotTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    bytepluscc_snapshot_resource = bytepluscc.storageebs.Snapshot("byteplusccSnapshotResource",
    snapshot_name="string",
    volume_id="string",
    description="string",
    project_name="string",
    retention_days=0,
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const byteplusccSnapshotResource = new bytepluscc.storageebs.Snapshot("byteplusccSnapshotResource", {
    snapshotName: "string",
    volumeId: "string",
    description: "string",
    projectName: "string",
    retentionDays: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: bytepluscc:storageebs:Snapshot
properties:
    description: string
    projectName: string
    retentionDays: 0
    snapshotName: string
    tags:
        - key: string
          value: string
    volumeId: 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:

    SnapshotName string
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    VolumeId string
    快照相关的云盘ID。
    Description string
    快照描述信息，默认为空，长度限制为0~255个字符。
    ProjectName string
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    RetentionDays int
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    Tags List<Byteplus.SnapshotTag>
    SnapshotName string
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    VolumeId string
    快照相关的云盘ID。
    Description string
    快照描述信息，默认为空，长度限制为0~255个字符。
    ProjectName string
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    RetentionDays int
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    Tags []SnapshotTagArgs
    snapshotName String
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    volumeId String
    快照相关的云盘ID。
    description String
    快照描述信息，默认为空，长度限制为0~255个字符。
    projectName String
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retentionDays Integer
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    tags List<SnapshotTag>
    snapshotName string
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    volumeId string
    快照相关的云盘ID。
    description string
    快照描述信息，默认为空，长度限制为0~255个字符。
    projectName string
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retentionDays number
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    tags SnapshotTag[]
    snapshot_name str
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    volume_id str
    快照相关的云盘ID。
    description str
    快照描述信息，默认为空，长度限制为0~255个字符。
    project_name str
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retention_days int
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    tags Sequence[SnapshotTagArgs]
    snapshotName String
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    volumeId String
    快照相关的云盘ID。
    description String
    快照描述信息，默认为空，长度限制为0~255个字符。
    projectName String
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retentionDays Number
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    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
    快照创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    镜像ID
    InstantAccess bool
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    Progress int
    快照转储进度。
    Shared bool
    快照是否共享。
    SnapshotGroupId string
    快照一致性组ID。
    SnapshotId string
    快照ID。
    SnapshotType string
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    Status string
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    VolumeKind string
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    VolumeName string
    云盘名称。
    VolumeSize int
    云盘大小，单位为GiB。
    VolumeStatus string
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    VolumeType string
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    ZoneId string
    快照所在的可用区ID。
    CreationTime string
    快照创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    镜像ID
    InstantAccess bool
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    Progress int
    快照转储进度。
    Shared bool
    快照是否共享。
    SnapshotGroupId string
    快照一致性组ID。
    SnapshotId string
    快照ID。
    SnapshotType string
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    Status string
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    VolumeKind string
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    VolumeName string
    云盘名称。
    VolumeSize int
    云盘大小，单位为GiB。
    VolumeStatus string
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    VolumeType string
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    ZoneId string
    快照所在的可用区ID。
    creationTime String
    快照创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    镜像ID
    instantAccess Boolean
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress Integer
    快照转储进度。
    shared Boolean
    快照是否共享。
    snapshotGroupId String
    快照一致性组ID。
    snapshotId String
    快照ID。
    snapshotType String
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status String
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    volumeKind String
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volumeName String
    云盘名称。
    volumeSize Integer
    云盘大小，单位为GiB。
    volumeStatus String
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volumeType String
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zoneId String
    快照所在的可用区ID。
    creationTime string
    快照创建时间。
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    镜像ID
    instantAccess boolean
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress number
    快照转储进度。
    shared boolean
    快照是否共享。
    snapshotGroupId string
    快照一致性组ID。
    snapshotId string
    快照ID。
    snapshotType string
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status string
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    volumeKind string
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volumeName string
    云盘名称。
    volumeSize number
    云盘大小，单位为GiB。
    volumeStatus string
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volumeType string
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zoneId string
    快照所在的可用区ID。
    creation_time str
    快照创建时间。
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    镜像ID
    instant_access bool
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress int
    快照转储进度。
    shared bool
    快照是否共享。
    snapshot_group_id str
    快照一致性组ID。
    snapshot_id str
    快照ID。
    snapshot_type str
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status str
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    volume_kind str
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volume_name str
    云盘名称。
    volume_size int
    云盘大小，单位为GiB。
    volume_status str
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volume_type str
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zone_id str
    快照所在的可用区ID。
    creationTime String
    快照创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    镜像ID
    instantAccess Boolean
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress Number
    快照转储进度。
    shared Boolean
    快照是否共享。
    snapshotGroupId String
    快照一致性组ID。
    snapshotId String
    快照ID。
    snapshotType String
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status String
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    volumeKind String
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volumeName String
    云盘名称。
    volumeSize Number
    云盘大小，单位为GiB。
    volumeStatus String
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volumeType String
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zoneId String
    快照所在的可用区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,
        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: bytepluscc: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
    快照创建时间。
    Description string
    快照描述信息，默认为空，长度限制为0~255个字符。
    ImageId string
    镜像ID
    InstantAccess bool
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    Progress int
    快照转储进度。
    ProjectName string
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    RetentionDays int
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    Shared bool
    快照是否共享。
    SnapshotGroupId string
    快照一致性组ID。
    SnapshotId string
    快照ID。
    SnapshotName string
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    SnapshotType string
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    Status string
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    Tags List<Byteplus.SnapshotTag>
    VolumeId string
    快照相关的云盘ID。
    VolumeKind string
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    VolumeName string
    云盘名称。
    VolumeSize int
    云盘大小，单位为GiB。
    VolumeStatus string
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    VolumeType string
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    ZoneId string
    快照所在的可用区ID。
    CreationTime string
    快照创建时间。
    Description string
    快照描述信息，默认为空，长度限制为0~255个字符。
    ImageId string
    镜像ID
    InstantAccess bool
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    Progress int
    快照转储进度。
    ProjectName string
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    RetentionDays int
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    Shared bool
    快照是否共享。
    SnapshotGroupId string
    快照一致性组ID。
    SnapshotId string
    快照ID。
    SnapshotName string
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    SnapshotType string
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    Status string
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    Tags []SnapshotTagArgs
    VolumeId string
    快照相关的云盘ID。
    VolumeKind string
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    VolumeName string
    云盘名称。
    VolumeSize int
    云盘大小，单位为GiB。
    VolumeStatus string
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    VolumeType string
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    ZoneId string
    快照所在的可用区ID。
    creationTime String
    快照创建时间。
    description String
    快照描述信息，默认为空，长度限制为0~255个字符。
    imageId String
    镜像ID
    instantAccess Boolean
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress Integer
    快照转储进度。
    projectName String
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retentionDays Integer
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    shared Boolean
    快照是否共享。
    snapshotGroupId String
    快照一致性组ID。
    snapshotId String
    快照ID。
    snapshotName String
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    snapshotType String
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status String
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    tags List<SnapshotTag>
    volumeId String
    快照相关的云盘ID。
    volumeKind String
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volumeName String
    云盘名称。
    volumeSize Integer
    云盘大小，单位为GiB。
    volumeStatus String
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volumeType String
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zoneId String
    快照所在的可用区ID。
    creationTime string
    快照创建时间。
    description string
    快照描述信息，默认为空，长度限制为0~255个字符。
    imageId string
    镜像ID
    instantAccess boolean
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress number
    快照转储进度。
    projectName string
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retentionDays number
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    shared boolean
    快照是否共享。
    snapshotGroupId string
    快照一致性组ID。
    snapshotId string
    快照ID。
    snapshotName string
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    snapshotType string
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status string
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    tags SnapshotTag[]
    volumeId string
    快照相关的云盘ID。
    volumeKind string
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volumeName string
    云盘名称。
    volumeSize number
    云盘大小，单位为GiB。
    volumeStatus string
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volumeType string
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zoneId string
    快照所在的可用区ID。
    creation_time str
    快照创建时间。
    description str
    快照描述信息，默认为空，长度限制为0~255个字符。
    image_id str
    镜像ID
    instant_access bool
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress int
    快照转储进度。
    project_name str
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retention_days int
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    shared bool
    快照是否共享。
    snapshot_group_id str
    快照一致性组ID。
    snapshot_id str
    快照ID。
    snapshot_name str
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    snapshot_type str
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status str
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    tags Sequence[SnapshotTagArgs]
    volume_id str
    快照相关的云盘ID。
    volume_kind str
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volume_name str
    云盘名称。
    volume_size int
    云盘大小，单位为GiB。
    volume_status str
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volume_type str
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zone_id str
    快照所在的可用区ID。
    creationTime String
    快照创建时间。
    description String
    快照描述信息，默认为空，长度限制为0~255个字符。
    imageId String
    镜像ID
    instantAccess Boolean
    快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
    progress Number
    快照转储进度。
    projectName String
    快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
    retentionDays Number
    快照保留时间，单位为天，取值说明如下：空：永久保留快照 。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
    shared Boolean
    快照是否共享。
    snapshotGroupId String
    快照一致性组ID。
    snapshotId String
    快照ID。
    snapshotName String
    创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
    snapshotType String
    快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
    status String
    快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
    tags List<Property Map>
    volumeId String
    快照相关的云盘ID。
    volumeKind String
    云盘种类，取值说明如下：system：系统盘。data：数据盘。
    volumeName String
    云盘名称。
    volumeSize Number
    云盘大小，单位为GiB。
    volumeStatus String
    云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
    volumeType String
    云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
    zoneId String
    快照所在的可用区ID。

    Supporting Types

    SnapshotTag, SnapshotTagArgs

    Key string
    为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
    Value string
    为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。
    Key string
    为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
    Value string
    为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。
    key String
    为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
    value String
    为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。
    key string
    为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
    value string
    为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。
    key str
    为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
    value str
    为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。
    key String
    为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
    value String
    为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

    Import

    $ pulumi import bytepluscc:storageebs/snapshot:Snapshot example "snapshot_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Meet Neo: Your AI Platform Teammate