SnapshotProps
Properties for defining a Snapshot
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-snapshot
Initializer
import com.aliyun.ros.cdk.ecs.SnapshotProps;
SnapshotProps.builder()
.diskId(java.lang.String)
.diskId(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .instantAccess(java.lang.Boolean)
// .instantAccess(IResolvable)
// .instantAccessRetentionDays(java.lang.Number)
// .instantAccessRetentionDays(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .retentionDays(java.lang.Number)
// .retentionDays(IResolvable)
// .snapshotName(java.lang.String)
// .snapshotName(IResolvable)
// .tags(java.util.List<TagsProperty>)
// .timeout(java.lang.Number)
// .timeout(IResolvable)
.build();
Properties
Name | Type | Description |
---|---|---|
diskId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property diskId: Indicates the ID of the specified disk. |
description |
java.lang.String OR com.aliyun.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:\/\/. |
instantAccess |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property instantAccess: Specifies whether to enable the instant access feature. |
instantAccessRetentionDays |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property instantAccessRetentionDays: Specifies the retention period of the instant access feature. |
resourceGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property resourceGroupId: Resource group id. |
retentionDays |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property retentionDays: Set the retention period of a snapshot in days. |
snapshotName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property snapshotName: The name of the snapshot, [2, 128] English or Chinese characters. |
tags |
java.util.List<TagsProperty> |
Property tags: Tags to attach to instance. |
timeout |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property timeout: The number of minutes to wait for create snapshot. |
diskId
Required
public java.lang.Object getDiskId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property diskId: Indicates the ID of the specified disk.
description
Optional
public java.lang.Object getDescription();
- Type: java.lang.String OR com.aliyun.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.
instantAccess
Optional
public java.lang.Object getInstantAccess();
- Type: java.lang.Boolean OR com.aliyun.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.
instantAccessRetentionDays
Optional
public java.lang.Object getInstantAccessRetentionDays();
- Type: java.lang.Number OR com.aliyun.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.
resourceGroupId
Optional
public java.lang.Object getResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Resource group id.
retentionDays
Optional
public java.lang.Object getRetentionDays();
- Type: java.lang.Number OR com.aliyun.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.
snapshotName
Optional
public java.lang.Object getSnapshotName();
- Type: java.lang.String OR com.aliyun.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://.
tags
Optional
public java.util.List<TagsProperty> getTags();
- Type: java.util.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.
timeout
Optional
public java.lang.Object getTimeout();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property timeout: The number of minutes to wait for create snapshot.