Skip to content

SnapshotsProps

Properties for defining a Snapshots.

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

Initializer 

import com.aliyun.ros.cdk.ecs.datasource.SnapshotsProps;
SnapshotsProps.builder()
//  .category(java.lang.String)
//  .category(IResolvable)
//  .diskId(java.lang.String)
//  .diskId(IResolvable)
//  .encrypted(java.lang.Boolean)
//  .encrypted(IResolvable)
//  .filters(IResolvable)
//  .filters(java.util.List<FiltersProperty)
//  .filters(IResolvable>)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .snapshotIds(IResolvable)
//  .snapshotIds(java.util.List<java.lang.String)
//  .snapshotIds(IResolvable>)
//  .snapshotLinkId(java.lang.String)
//  .snapshotLinkId(IResolvable)
//  .snapshotName(java.lang.String)
//  .snapshotName(IResolvable)
//  .snapshotType(java.lang.String)
//  .snapshotType(IResolvable)
//  .sourceDiskType(java.lang.String)
//  .sourceDiskType(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .usage(java.lang.String)
//  .usage(IResolvable)
    .build();

Properties

Name Type Description
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The category of the snapshot.
diskId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property diskId: The ID of the disk.
encrypted java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property encrypted: Specifies whether the snapshot is encrypted.
filters com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property filters: Filter value when querying resources.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the instance.
kmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the data disk.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the snapshot belongs.
snapshotIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property snapshotIds: The IDs of snapshots.
snapshotLinkId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property snapshotLinkId: The ID of the snapshot chain.
snapshotName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property snapshotName: The name of the snapshot.
snapshotType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property snapshotType: Specifies whether the snapshot has been used to create images or disks.
sourceDiskType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceDiskType: The type of the source disk for which the snapshot was created.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The status of the snapshot.
tags java.util.List Property tags: Tags of snapshot.
usage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property usage: The type of the snapshot.

categoryOptional 

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

diskIdOptional 

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

Property diskId: The ID of the disk.

encryptedOptional 

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

Property encrypted: Specifies whether the snapshot is encrypted.

Default value: false.

filtersOptional 

public java.lang.Object getFilters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property filters: Filter value when querying resources.

instanceIdOptional 

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

Property instanceId: The ID of the instance.

kmsKeyIdOptional 

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

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

refreshOptionsOptional 

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

resourceGroupIdOptional 

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

snapshotIdsOptional 

public java.lang.Object getSnapshotIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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 (,).

snapshotLinkIdOptional 

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

Property snapshotLinkId: The ID of the snapshot chain.

snapshotNameOptional 

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

Property snapshotName: The name of the snapshot.

snapshotTypeOptional 

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

sourceDiskTypeOptional 

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

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

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

Property tags: Tags of snapshot.

usageOptional 

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