Skip to content

DisksProps

Properties for defining a Disks.

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

Initializer 

import { datasource } from '@alicloud/ros-cdk-ecs'
const disksProps: datasource.DisksProps = { ... }

Properties

Name Type Description
additionalAttributes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property additionalAttributes: The value of attribute N.
autoSnapshotPolicyId string | @alicloud/ros-cdk-core.IResolvable Property autoSnapshotPolicyId: The ID of the automatic snapshot policy that is applied to the cloud disk.
category string | @alicloud/ros-cdk-core.IResolvable Property category: The category of the disk.
deleteAutoSnapshot string | @alicloud/ros-cdk-core.IResolvable Property deleteAutoSnapshot: Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.
deleteWithInstance boolean | @alicloud/ros-cdk-core.IResolvable Property deleteWithInstance: Specifies whether to release the cloud disk when its associated instance is released.
diskChargeType string | @alicloud/ros-cdk-core.IResolvable Property diskChargeType: The billing method of the disk.
diskIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property diskIds: The IDs of disks.
diskName string | @alicloud/ros-cdk-core.IResolvable Property diskName: The name of the disk.
diskType string | @alicloud/ros-cdk-core.IResolvable Property diskType: The type of the disk.
enableAutomatedSnapshotPolicy boolean | @alicloud/ros-cdk-core.IResolvable Property enableAutomatedSnapshotPolicy: Specifies whether an automatic snapshot policy is applied to the cloud disk.
enableAutoSnapshot boolean | @alicloud/ros-cdk-core.IResolvable Property enableAutoSnapshot: Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.
enableShared string | @alicloud/ros-cdk-core.IResolvable Property enableShared: Specifies whether the disk is a Shared Block Storage device.
encrypted boolean | @alicloud/ros-cdk-core.IResolvable Property encrypted: Specifies whether to query only encrypted cloud disks.
filters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-ecs.datasource.RosDisks.FiltersProperty | @alicloud/ros-cdk-core.IResolvable[] Property filters: Filter value when querying resources.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The ID of the instance to which the disk is attached.
kmsKeyId string | @alicloud/ros-cdk-core.IResolvable Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the cloud disk.
multiAttach string | @alicloud/ros-cdk-core.IResolvable Property multiAttach: Specifies whether the multi-attach feature is enabled for the disk.
portable string | @alicloud/ros-cdk-core.IResolvable Property portable: Specifies whether the disk is removable.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which the disk belongs.
snapshotId string | @alicloud/ros-cdk-core.IResolvable Property snapshotId: The ID of the snapshot used to create the cloud disk.
status string | @alicloud/ros-cdk-core.IResolvable Property status: The state of the cloud disk.
tags @alicloud/ros-cdk-ecs.datasource.RosDisks.TagsProperty[] Property tags: Tags of disks.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the zone for which to query resources.

additionalAttributesOptional 

public readonly additionalAttributes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property additionalAttributes: The value of attribute N.

Set the value to IOPS, which indicates the maximum IOPS of the disk.

autoSnapshotPolicyIdOptional 

public readonly autoSnapshotPolicyId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property autoSnapshotPolicyId: The ID of the automatic snapshot policy that is applied to the cloud disk.

categoryOptional 

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The category of the disk.

Valid values: all: all disk categories cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD ephemeral: retired local disk ephemeral_ssd: local SSD cloud_essd: ESSD local_ssd_pro: I\/O-intensive local disk local_hdd_pro: throughput-intensive local disk

deleteAutoSnapshotOptional 

public readonly deleteAutoSnapshot: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property deleteAutoSnapshot: Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.

Default value: false.

deleteWithInstanceOptional 

public readonly deleteWithInstance: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deleteWithInstance: Specifies whether to release the cloud disk when its associated instance is released.

Valid values: true: The cloud disk is released when its associated instance is released. false: The cloud disk is not released but is retained as a pay-as-you-go data disk when its associated instance is released. Default value: false.

diskChargeTypeOptional 

public readonly diskChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property diskChargeType: The billing method of the disk.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go

diskIdsOptional 

public readonly diskIds: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property diskIds: The IDs of disks.

The value is a JSON array that consists of up to 100 disk IDs. Separate the disk IDs with commas (,).

diskNameOptional 

public readonly diskName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property diskName: The name of the disk.

diskTypeOptional 

public readonly diskType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property diskType: The type of the disk.

Valid values: all: system disk and data disk system: system disk data: data disk Default value: all.

enableAutomatedSnapshotPolicyOptional 

public readonly enableAutomatedSnapshotPolicy: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAutomatedSnapshotPolicy: Specifies whether an automatic snapshot policy is applied to the cloud disk.

true: An automatic snapshot policy is applied to the cloud disk. false: No automatic snapshot policy is applied to the cloud disk. Default value: false.

enableAutoSnapshotOptional 

public readonly enableAutoSnapshot: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAutoSnapshot: Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.

true: The automatic snapshot policy feature is enabled for the cloud disk. false: The automatic snapshot policy feature is disabled for the cloud disk. Note By default, the automatic snapshot policy feature is enabled for created cloud disks. You need only to apply an automatic snapshot policy to a cloud disk before you can use the automatic snapshot policy.

enableSharedOptional 

public readonly enableShared: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property enableShared: Specifies whether the disk is a Shared Block Storage device.

encryptedOptional 

public readonly encrypted: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property encrypted: Specifies whether to query only encrypted cloud disks.

Default value: false.

filtersOptional 

public readonly filters: IResolvable | FiltersProperty | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-ecs.datasource.RosDisks.FiltersProperty | @alicloud/ros-cdk-core.IResolvable[]

Property filters: Filter value when querying resources.

instanceIdOptional 

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceId: The ID of the instance to which the disk is attached.

kmsKeyIdOptional 

public readonly kmsKeyId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

multiAttachOptional 

public readonly multiAttach: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property multiAttach: Specifies whether the multi-attach feature is enabled for the disk.

Valid values: Disabled: The multi-attach feature is disabled. Enabled: The multi-attach feature is enabled. LegacyShared: Shared Block Storage devices are queried. The multi-attach feature is in invitational preview. To use this feature, submit a ticket.

portableOptional 

public readonly portable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property portable: Specifies whether the disk is removable.

Valid values: true: The disk is removable.A removable disk can independently exist and can be attached to or detached from an instance within the same zone. false: The disk is not removable. A disk that is not removable cannot independently exist or be attached to or detached from an instance within the same zone. The Portable attribute of the following disks is false, and these disks share the same lifecycle with their associated instances: Local disks Local SSDs Subscription data disks

refreshOptionsOptional 

public readonly refreshOptions: string | IResolvable;
  • Type: string | @alicloud/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 readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group to which the disk 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.

snapshotIdOptional 

public readonly snapshotId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property snapshotId: The ID of the snapshot used to create the cloud disk.

statusOptional 

public readonly status: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property status: The state of the cloud disk.

For more information, see Disk states. Valid values: In_use Available Attaching Detaching Creating ReIniting All Default value: All.

tagsOptional 

public readonly tags: TagsProperty[];
  • Type: @alicloud/ros-cdk-ecs.datasource.RosDisks.TagsProperty[]

Property tags: Tags of disks.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The ID of the zone for which to query resources.