Skip to content

SnapshotGroupProps

Properties for defining a SnapshotGroup.

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

Initializer 

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

Properties

Name Type Description
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the snapshot-consistent group.
diskIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property diskIds: The IDs of cloud disk for which you want to create snapshots.
excludeDiskIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property excludeDiskIds: The IDs of cloud disk for which you do not want to create snapshots.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The instance ID.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the snapshot-consistent group.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which the snapshot-consistent group belongs.
tags TagsProperty[] Property tags: Tags to attach to snapshot-consistent group.

descriptionOptional 

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

Property description: The description of the snapshot-consistent group.

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

diskIdsOptional 

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

Property diskIds: The IDs of cloud disk for which you want to create snapshots.

You can specify multiple cloud disk IDs across instances within the same zone. The length of the list ranges from 1 to 16. A single snapshot-consistent group can contain snapshots of up to 16 cloud disks whose total disk size does not exceed 32 TiB. Take note of the following items: You cannot specify both DiskIds and ExcludeDiskIdin the same request. If InstanceId is set, you can use DiskIds to specify only cloud disks attached to the instance specified by InstanceId, and you cannot use DiskIds to specify cloud disks attached to multiple instances.

excludeDiskIdsOptional 

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

Property excludeDiskIds: The IDs of cloud disk for which you do not want to create snapshots.

If this parameter is specified, the created snapshot-consistent group does not contain snapshots of the cloud disk. The length of the list ranges from 1 to 16. This parameter is empty by default, which indicates that snapshots are created for all the disks of the instance. Note You cannot specify ExcludeDiskIds and DiskIds in the same request.

instanceIdOptional 

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

Property instanceId: The instance ID.

nameOptional 

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

Property name: The name of the snapshot-consistent group.

The name must be 2 to 128 characters in length. The name can contain letters, digits, periods (.), underscores (_), hyphens (-), and colons (:). It must start with a letter and cannot start with http:\/\/ or https:\/\/.

resourceGroupIdOptional 

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

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

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to snapshot-consistent group.

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