Skip to content

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 snapshot description must be 2 to 256 characters in length and cannot start 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: The retention period for the Instant Access feature, in days.
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: The retention period of the snapshot, in days.
snapshotName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property snapshotName: The snapshot name must be 2 to 128 characters long.
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.

diskIdRequired

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.


descriptionOptional

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.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.


instantAccessOptional

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 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.


instantAccessRetentionDaysOptional

public java.lang.Object getInstantAccessRetentionDays();
  • Type: java.lang.Number OR com.aliyun.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.


resourceGroupIdOptional

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.


retentionDaysOptional

public java.lang.Object getRetentionDays();
  • Type: java.lang.Number OR com.aliyun.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.


snapshotNameOptional

public java.lang.Object getSnapshotName();
  • Type: java.lang.String OR com.aliyun.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:\/\/ or https:\/\/. To avoid conflicts with auto snapshot names, the name cannot start with auto.


tagsOptional

public java.util.List<TagsProperty> getTags();

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

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.