Skip to content

SnapshotProps

Properties for defining a Snapshot.

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

Initializer 

import ros_cdk_ecs
ros_cdk_ecs.SnapshotProps(
  disk_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  instant_access: typing.Union[bool, IResolvable] = None,
  instant_access_retention_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  retention_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  snapshot_name: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

Name Type Description
disk_id typing.Union[str, ros_cdk_core.IResolvable] Property diskId: Indicates the ID of the specified disk.
description typing.Union[str, 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:\/\/.
instant_access typing.Union[bool, ros_cdk_core.IResolvable] Property instantAccess: Specifies whether to enable the instant access feature.
instant_access_retention_days typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property instantAccessRetentionDays: Specifies the retention period of the instant access feature.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
retention_days typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property retentionDays: Set the retention period of a snapshot in days.
snapshot_name typing.Union[str, ros_cdk_core.IResolvable] Property snapshotName: The name of the snapshot, [2, 128] English or Chinese characters.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property timeout: The number of minutes to wait for create snapshot.

disk_idRequired 

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

Property diskId: Indicates the ID of the specified disk.

descriptionOptional 

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

instant_accessOptional 

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

instant_access_retention_daysOptional 

instant_access_retention_days: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

resource_group_idOptional 

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

Property resourceGroupId: Resource group id.

retention_daysOptional 

retention_days: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

snapshot_nameOptional 

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

tags: typing.List[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 

timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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