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 description of a snapshot can be 2 to 256 characters in length and cannot begin 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: Specifies the retention period of the instant access feature.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
retentionDays number | @alicloud/ros-cdk-core.IResolvable Property retentionDays: Set the retention period of a snapshot in days.
snapshotName string | @alicloud/ros-cdk-core.IResolvable Property snapshotName: The name of the snapshot, [2, 128] English or Chinese characters.
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 description of a snapshot can be 2 to 256 characters in length and cannot begin with http:\/\/ or https:\/\/.

The description will appear on the console. By default, the value is zero.

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 enhanced SSDs (ESSDs) false: disables the instant access feature. If InstantAccess is set to false, normal snapshots are created. Default value: false. Note This parameter and the Category parameter cannot be specified at the same time. For more information, see the "Description" section in this topic.

instantAccessRetentionDaysOptional 

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

Property instantAccessRetentionDays: Specifies the retention period of the instant access feature.

After the retention period ends, the snapshot is automatically released. This parameter takes effect only when InstantAccess is set to true. Unit: days. Valid values: 1 to 65535. By default, the value of this parameter is the same as that of RetentionDays.

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: Set the retention period of a snapshot in days.

The snapshot will be automatically released after the retention period expires. The value ranges from 1 to 65536.

snapshotNameOptional 

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

Property snapshotName: The name of the snapshot, [2, 128] English or Chinese characters.

It must begin with an uppercase\/lowercase letter or a Chinese character, and may contain numbers, '_' or '-'. It cannot begin with http:\/\/ or https:\/\/.

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.