Skip to content

DisksProps

Properties for defining a Disks.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new DisksProps {
    object AdditionalAttributes = null,
    object AutoSnapshotPolicyId = null,
    object Category = null,
    object DeleteAutoSnapshot = null,
    object DeleteWithInstance = null,
    object DiskChargeType = null,
    object DiskIds = null,
    object DiskName = null,
    object DiskType = null,
    object EnableAutomatedSnapshotPolicy = null,
    object EnableAutoSnapshot = null,
    object EnableShared = null,
    object Encrypted = null,
    object Filters = null,
    object InstanceId = null,
    object KmsKeyId = null,
    object MultiAttach = null,
    object Portable = null,
    object RefreshOptions = null,
    object ResourceGroupId = null,
    object SnapshotId = null,
    object Status = null,
    TagsProperty[] Tags = null,
    object ZoneId = null
};

Properties

Name Type Description
AdditionalAttributes object Property additionalAttributes: The value of attribute N.
AutoSnapshotPolicyId object Property autoSnapshotPolicyId: The ID of the automatic snapshot policy that is applied to the cloud disk.
Category object Property category: The category of the disk.
DeleteAutoSnapshot object Property deleteAutoSnapshot: Specifies whether to delete the automatic snapshots of the cloud disk when the disk is released.
DeleteWithInstance object Property deleteWithInstance: Specifies whether to release the cloud disk when its associated instance is released.
DiskChargeType object Property diskChargeType: The billing method of the disk.
DiskIds object Property diskIds: The IDs of disks.
DiskName object Property diskName: The name of the disk.
DiskType object Property diskType: The type of the disk.
EnableAutomatedSnapshotPolicy object Property enableAutomatedSnapshotPolicy: Specifies whether an automatic snapshot policy is applied to the cloud disk.
EnableAutoSnapshot object Property enableAutoSnapshot: Specifies whether the automatic snapshot policy feature is enabled for the cloud disk.
EnableShared object Property enableShared: Specifies whether the disk is a Shared Block Storage device.
Encrypted object Property encrypted: Specifies whether to query only encrypted cloud disks.
Filters object Property filters: Filter value when querying resources.
InstanceId object Property instanceId: The ID of the instance to which the disk is attached.
KmsKeyId object Property kmsKeyId: The ID of the Key Management Service (KMS) key used by the cloud disk.
MultiAttach object Property multiAttach: Specifies whether the multi-attach feature is enabled for the disk.
Portable object Property portable: Specifies whether the disk is removable.
RefreshOptions object Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
ResourceGroupId object Property resourceGroupId: The ID of the resource group to which the disk belongs.
SnapshotId object Property snapshotId: The ID of the snapshot used to create the cloud disk.
Status object Property status: The state of the cloud disk.
Tags AlibabaCloud.SDK.ROS.CDK.Ecs.datasource.RosDisks.TagsProperty[] Property tags: Tags of disks.
ZoneId object Property zoneId: The ID of the zone for which to query resources.

AdditionalAttributesOptional

public object AdditionalAttributes { get; set; }
  • Type: object

Property additionalAttributes: The value of attribute N.

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


AutoSnapshotPolicyIdOptional

public object AutoSnapshotPolicyId { get; set; }
  • Type: object

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


CategoryOptional

public object Category { get; set; }
  • Type: object

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 object DeleteAutoSnapshot { get; set; }
  • Type: object

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

Default value: false.


DeleteWithInstanceOptional

public object DeleteWithInstance { get; set; }
  • Type: object

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 object DiskChargeType { get; set; }
  • Type: object

Property diskChargeType: The billing method of the disk.

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


DiskIdsOptional

public object DiskIds { get; set; }
  • Type: object

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 object DiskName { get; set; }
  • Type: object

Property diskName: The name of the disk.


DiskTypeOptional

public object DiskType { get; set; }
  • Type: object

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 object EnableAutomatedSnapshotPolicy { get; set; }
  • Type: object

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 object EnableAutoSnapshot { get; set; }
  • Type: object

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 object EnableShared { get; set; }
  • Type: object

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


EncryptedOptional

public object Encrypted { get; set; }
  • Type: object

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

Default value: false.


FiltersOptional

public object Filters { get; set; }
  • Type: object

Property filters: Filter value when querying resources.


InstanceIdOptional

public object InstanceId { get; set; }
  • Type: object

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


KmsKeyIdOptional

public object KmsKeyId { get; set; }
  • Type: object

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


MultiAttachOptional

public object MultiAttach { get; set; }
  • Type: object

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 object Portable { get; set; }
  • Type: object

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 object RefreshOptions { get; set; }
  • Type: object

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 object ResourceGroupId { get; set; }
  • Type: object

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 object SnapshotId { get; set; }
  • Type: object

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


StatusOptional

public object Status { get; set; }
  • Type: object

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 TagsProperty[] Tags { get; set; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Ecs.datasource.RosDisks.TagsProperty[]

Property tags: Tags of disks.


ZoneIdOptional

public object ZoneId { get; set; }
  • Type: object

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