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 snapshot description must be 2 to 256 characters in length and cannot start 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: The retention period for the Instant Access feature, in days. |
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: The retention period of the snapshot, in days. |
snapshot_name | typing.Union[str, ros_cdk_core.IResolvable] | Property snapshotName: The snapshot name must be 2 to 128 characters long. |
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 snapshot description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.
This parameter is empty by default.
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 snapshots of ESSD cloud disks.
- false: Disables the Instant Access feature. A standard snapshot is created. Default value: false.
This parameter is deprecated. standard snapshots for ESSD cloud disks now include the Instant Access feature by default at no additional cost.
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: The retention period for the Instant Access feature, in days.
The snapshot is automatically deleted when this retention period expires. This parameter takes effect only when InstantAccess is set to true. Valid values: 1 to 65,535. Defaults to the value of RetentionDays.
This parameter is deprecated. standard snapshots for ESSD cloud disks now include the Instant Access feature by default at no additional cost.
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: The retention period of the snapshot, in days.
Valid values: 1 to 65,536. The snapshot is automatically deleted when the retention period expires. If this parameter is not specified, the snapshot is retained indefinitely.
snapshot_nameOptional
snapshot_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property snapshotName: The snapshot name must be 2 to 128 characters long.
It must start with a letter or a Chinese character and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
The name cannot start with
http:\/\/orhttps:\/\/. To avoid conflicts with auto snapshot names, the name cannot start withauto.
tagsOptional
tags: typing.List[TagsProperty]
- Type: 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.