Skip to content

SnapshotsProps

Properties for defining a Snapshots.

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

Initializer 

from ros_cdk_ecs import datasource
datasource.SnapshotsProps(
  category: typing.Union[str, IResolvable] = None,
  disk_id: typing.Union[str, IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  filters: typing.Union[IResolvable, typing.List[typing.Union[FiltersProperty, IResolvable]]] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  snapshot_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  snapshot_link_id: typing.Union[str, IResolvable] = None,
  snapshot_name: typing.Union[str, IResolvable] = None,
  snapshot_type: typing.Union[str, IResolvable] = None,
  source_disk_type: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  usage: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
category typing.Union[str, ros_cdk_core.IResolvable] Property category: The category of the snapshot.
disk_id typing.Union[str, ros_cdk_core.IResolvable] Property diskId: The ID of the disk.
encrypted typing.Union[bool, ros_cdk_core.IResolvable] Property encrypted: Specifies whether the snapshot is encrypted.
filters typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_ecs.datasource.RosSnapshots.FiltersProperty, ros_cdk_core.IResolvable]]] Property filters: Filter value when querying resources.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the instance.
kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the snapshot belongs.
snapshot_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property snapshotIds: The IDs of snapshots.
snapshot_link_id typing.Union[str, ros_cdk_core.IResolvable] Property snapshotLinkId: The ID of the snapshot chain.
snapshot_name typing.Union[str, ros_cdk_core.IResolvable] Property snapshotName: The name of the snapshot.
snapshot_type typing.Union[str, ros_cdk_core.IResolvable] Property snapshotType: Specifies whether the snapshot has been used to create images or disks.
source_disk_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceDiskType: The type of the source disk for which the snapshot was created.
status typing.Union[str, ros_cdk_core.IResolvable] Property status: The status of the snapshot.
tags typing.List[ros_cdk_ecs.datasource.RosSnapshots.TagsProperty] Property tags: Tags of snapshot.
usage typing.Union[str, ros_cdk_core.IResolvable] Property usage: The type of the snapshot.

categoryOptional 

category: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

disk_idOptional 

disk_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property diskId: The ID of the disk.

encryptedOptional 

encrypted: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property encrypted: Specifies whether the snapshot is encrypted.

Default value: false.

filtersOptional 

filters: typing.Union[IResolvable, typing.List[typing.Union[FiltersProperty, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_ecs.datasource.RosSnapshots.FiltersProperty, ros_cdk_core.IResolvable]]]

Property filters: Filter value when querying resources.

instance_idOptional 

instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The ID of the instance.

kms_key_idOptional 

kms_key_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

refresh_optionsOptional 

refresh_options: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

resource_group_idOptional 

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

snapshot_idsOptional 

snapshot_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, 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 (,).

snapshot_link_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property snapshotLinkId: The ID of the snapshot chain.

snapshot_nameOptional 

snapshot_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property snapshotName: The name of the snapshot.

snapshot_typeOptional 

snapshot_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

source_disk_typeOptional 

source_disk_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

status: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

tags: typing.List[TagsProperty]
  • Type: typing.List[ros_cdk_ecs.datasource.RosSnapshots.TagsProperty]

Property tags: Tags of snapshot.

usageOptional 

usage: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.