Skip to content

SnapshotsProps

Properties for defining a Snapshots.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-ecs-snapshots

Initializer 

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new SnapshotsProps {
    object Category = null,
    object DiskId = null,
    object Encrypted = null,
    object Filters = null,
    object InstanceId = null,
    object KmsKeyId = null,
    object RefreshOptions = null,
    object ResourceGroupId = null,
    object SnapshotIds = null,
    object SnapshotLinkId = null,
    object SnapshotName = null,
    object SnapshotType = null,
    object SourceDiskType = null,
    object Status = null,
    TagsProperty[] Tags = null,
    object Usage = null
};

Properties

Name Type Description
Category object Property category: The category of the snapshot.
DiskId object Property diskId: The ID of the disk.
Encrypted object Property encrypted: Specifies whether the snapshot is encrypted.
Filters object Property filters: Filter value when querying resources.
InstanceId object Property instanceId: The ID of the instance.
KmsKeyId object Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.
RefreshOptions object Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
ResourceGroupId object Property resourceGroupId: The ID of the resource group to which the snapshot belongs.
SnapshotIds object Property snapshotIds: The IDs of snapshots.
SnapshotLinkId object Property snapshotLinkId: The ID of the snapshot chain.
SnapshotName object Property snapshotName: The name of the snapshot.
SnapshotType object Property snapshotType: Specifies whether the snapshot has been used to create images or disks.
SourceDiskType object Property sourceDiskType: The type of the source disk for which the snapshot was created.
Status object Property status: The status of the snapshot.
Tags AlibabaCloud.SDK.ROS.CDK.Ecs.datasource.RosSnapshots.TagsProperty[] Property tags: Tags of snapshot.
Usage object Property usage: The type of the snapshot.

CategoryOptional 

public object Category { get; set; }
  • Type: object

Property category: The category of the snapshot.

Valid values: Standard: normal snapshot Flash: local snapshot The local snapshot feature is replaced by the instant access feature. When you specify this parameter, take note of the following items: If you have used local snapshots before December 14, 2020, you can use this parameter. If you have not used local snapshots before December 14, 2020, you cannot use this parameter. Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.

DiskIdOptional 

public object DiskId { get; set; }
  • Type: object

Property diskId: The ID of the disk.

EncryptedOptional 

public object Encrypted { get; set; }
  • Type: object

Property encrypted: Specifies whether the snapshot is encrypted.

Default value: false.

FiltersOptional 

public object Filters { get; set; }
  • Type: object

Property filters: Filter value when querying resources.

InstanceIdOptional 

public object InstanceId { get; set; }
  • Type: object

Property instanceId: The ID of the instance.

KmsKeyIdOptional 

public object KmsKeyId { get; set; }
  • Type: object

Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.

RefreshOptionsOptional 

public object RefreshOptions { get; set; }
  • Type: object

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

ResourceGroupIdOptional 

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: The ID of the resource group to which the snapshot belongs.

If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

SnapshotIdsOptional 

public object SnapshotIds { get; set; }
  • Type: object

Property snapshotIds: The IDs of snapshots.

The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).

SnapshotLinkIdOptional 

public object SnapshotLinkId { get; set; }
  • Type: object

Property snapshotLinkId: The ID of the snapshot chain.

SnapshotNameOptional 

public object SnapshotName { get; set; }
  • Type: object

Property snapshotName: The name of the snapshot.

SnapshotTypeOptional 

public object SnapshotType { get; set; }
  • Type: object

Property snapshotType: Specifies whether the snapshot has been used to create images or disks.

Valid values: auto: automatic snapshot user: manual snapshot all: all snapshot types

SourceDiskTypeOptional 

public object SourceDiskType { get; set; }
  • Type: object

Property sourceDiskType: The type of the source disk for which the snapshot was created.

Valid values: System: system disk Data: data disk Note These values are case-insensitive.

StatusOptional 

public object Status { get; set; }
  • Type: object

Property status: The status of the snapshot.

Default value: all. Valid values: progressing: The snapshot is being created. accomplished: The snapshot is created. failed: The snapshot fails to be created. all: all snapshot statuses.

TagsOptional 

public TagsProperty[] Tags { get; set; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Ecs.datasource.RosSnapshots.TagsProperty[]

Property tags: Tags of snapshot.

UsageOptional 

public object Usage { get; set; }
  • Type: object

Property usage: The type of the snapshot.

Default value: all. Valid values: image: The snapshot has been used to create custom images. disk: The snapshot has been used to create disks. image_disk: The snapshot has been used to create custom images and data disks. none: The snapshot has not been used to create custom images or disks.