Skip to content

SnapshotsProps

Properties for defining a Snapshots.

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

Initializer 

import { datasource } from '@alicloud/ros-cdk-ecs'
const snapshotsProps: datasource.SnapshotsProps = { ... }

Properties

Name Type Description
category string | @alicloud/ros-cdk-core.IResolvable Property category: The category of the snapshot.
diskId string | @alicloud/ros-cdk-core.IResolvable Property diskId: The ID of the disk.
encrypted boolean | @alicloud/ros-cdk-core.IResolvable Property encrypted: Specifies whether the snapshot is encrypted.
filters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-ecs.datasource.RosSnapshots.FiltersProperty | @alicloud/ros-cdk-core.IResolvable[] Property filters: Filter value when querying resources.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The ID of the instance.
kmsKeyId string | @alicloud/ros-cdk-core.IResolvable Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which the snapshot belongs.
snapshotIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property snapshotIds: The IDs of snapshots.
snapshotLinkId string | @alicloud/ros-cdk-core.IResolvable Property snapshotLinkId: The ID of the snapshot chain.
snapshotName string | @alicloud/ros-cdk-core.IResolvable Property snapshotName: The name of the snapshot.
snapshotType string | @alicloud/ros-cdk-core.IResolvable Property snapshotType: Specifies whether the snapshot has been used to create images or disks.
sourceDiskType string | @alicloud/ros-cdk-core.IResolvable Property sourceDiskType: The type of the source disk for which the snapshot was created.
status string | @alicloud/ros-cdk-core.IResolvable Property status: The status of the snapshot.
tags @alicloud/ros-cdk-ecs.datasource.RosSnapshots.TagsProperty[] Property tags: Tags of snapshot.
usage string | @alicloud/ros-cdk-core.IResolvable Property usage: The type of the snapshot.

categoryOptional 

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

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

Property diskId: The ID of the disk.

encryptedOptional 

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

Property encrypted: Specifies whether the snapshot is encrypted.

Default value: false.

filtersOptional 

public readonly filters: IResolvable | FiltersProperty | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-ecs.datasource.RosSnapshots.FiltersProperty | @alicloud/ros-cdk-core.IResolvable[]

Property filters: Filter value when querying resources.

instanceIdOptional 

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

Property instanceId: The ID of the instance.

kmsKeyIdOptional 

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

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

refreshOptionsOptional 

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

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

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

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

Property snapshotLinkId: The ID of the snapshot chain.

snapshotNameOptional 

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

Property snapshotName: The name of the snapshot.

snapshotTypeOptional 

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

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

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

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 readonly tags: TagsProperty[];
  • Type: @alicloud/ros-cdk-ecs.datasource.RosSnapshots.TagsProperty[]

Property tags: Tags of snapshot.

usageOptional 

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

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.