Skip to content

SnapshotProps

Properties for defining a Snapshot.

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

Initializer 

import { SnapshotProps } from '@alicloud/ros-cdk-ecs'
const snapshotProps: SnapshotProps = { ... }

Properties

Name Type Description
diskId string | @alicloud/ros-cdk-core.IResolvable Property diskId: Indicates the ID of the specified disk.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The snapshot description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.
instantAccess boolean | @alicloud/ros-cdk-core.IResolvable Property instantAccess: Specifies whether to enable the Instant Access feature.
instantAccessRetentionDays number | @alicloud/ros-cdk-core.IResolvable Property instantAccessRetentionDays: The retention period for the Instant Access feature, in days.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
retentionDays number | @alicloud/ros-cdk-core.IResolvable Property retentionDays: The retention period of the snapshot, in days.
snapshotName string | @alicloud/ros-cdk-core.IResolvable Property snapshotName: The snapshot name must be 2 to 128 characters long.
tags TagsProperty[] Property tags: Tags to attach to instance.
timeout number | @alicloud/ros-cdk-core.IResolvable Property timeout: The number of minutes to wait for create snapshot.

diskIdRequired 

public readonly diskId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property diskId: Indicates the ID of the specified disk.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly instantAccess: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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 readonly instantAccessRetentionDays: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

retentionDaysOptional 

public readonly retentionDays: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 readonly snapshotName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly tags: TagsProperty[];

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 readonly timeout: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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