Skip to content

SnapshotProps

Properties for defining a Snapshot.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-snapshot

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new SnapshotProps {
    object DiskId,
    object Description = null,
    object InstantAccess = null,
    object InstantAccessRetentionDays = null,
    object ResourceGroupId = null,
    object RetentionDays = null,
    object SnapshotName = null,
    TagsProperty[] Tags = null,
    object Timeout = null
};

Properties

Name Type Description
DiskId object Property diskId: Indicates the ID of the specified disk.
Description object Property description: The snapshot description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.
InstantAccess object Property instantAccess: Specifies whether to enable the Instant Access feature.
InstantAccessRetentionDays object Property instantAccessRetentionDays: The retention period for the Instant Access feature, in days.
ResourceGroupId object Property resourceGroupId: Resource group id.
RetentionDays object Property retentionDays: The retention period of the snapshot, in days.
SnapshotName object Property snapshotName: The snapshot name must be 2 to 128 characters long.
Tags TagsProperty[] Property tags: Tags to attach to instance.
Timeout object Property timeout: The number of minutes to wait for create snapshot.

DiskIdRequired

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

Property diskId: Indicates the ID of the specified disk.


DescriptionOptional

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

Property description: The snapshot description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.

This parameter is empty by default.


InstantAccessOptional

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

Property instantAccess: Specifies whether to enable the Instant Access feature.

Valid values:

  • true: Enables the Instant Access feature. This feature can be enabled only for snapshots of ESSD cloud disks.
  • false: Disables the Instant Access feature. A standard snapshot is created. Default value: false.

This parameter is deprecated. standard snapshots for ESSD cloud disks now include the Instant Access feature by default at no additional cost.


InstantAccessRetentionDaysOptional

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

Property instantAccessRetentionDays: The retention period for the Instant Access feature, in days.

The snapshot is automatically deleted when this retention period expires. This parameter takes effect only when InstantAccess is set to true. Valid values: 1 to 65,535. Defaults to the value of RetentionDays.

This parameter is deprecated. standard snapshots for ESSD cloud disks now include the Instant Access feature by default at no additional cost.


ResourceGroupIdOptional

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

Property resourceGroupId: Resource group id.


RetentionDaysOptional

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

Property retentionDays: The retention period of the snapshot, in days.

Valid values: 1 to 65,536. The snapshot is automatically deleted when the retention period expires. If this parameter is not specified, the snapshot is retained indefinitely.


SnapshotNameOptional

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

Property snapshotName: The snapshot name must be 2 to 128 characters long.

It must start with a letter or a Chinese character and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

The name cannot start with http:\/\/ or https:\/\/. To avoid conflicts with auto snapshot names, the name cannot start with auto.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


TimeoutOptional

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

Property timeout: The number of minutes to wait for create snapshot.