Skip to content

Disk

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Disk.

Initializers 

import { datasource } from '@alicloud/ros-cdk-ecs'
new datasource.Disk(scope: Construct, id: string, props: DiskProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DiskProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import { datasource } from '@alicloud/ros-cdk-ecs'
datasource.Disk.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAttachedTime @alicloud/ros-cdk-core.IResolvable Attribute AttachedTime: The attached time.
attrAutoSnapshotPolicyId @alicloud/ros-cdk-core.IResolvable Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.
attrBurstingEnabled @alicloud/ros-cdk-core.IResolvable Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst).
attrCategory @alicloud/ros-cdk-core.IResolvable Attribute Category: Disk type.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time.
attrDeleteAutoSnapshot @alicloud/ros-cdk-core.IResolvable Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time.
attrDeleteWithInstance @alicloud/ros-cdk-core.IResolvable Attribute DeleteWithInstance: Whether to release with the instance.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description.
attrDetachedTime @alicloud/ros-cdk-core.IResolvable Attribute DetachedTime: Unloading time.
attrDevice @alicloud/ros-cdk-core.IResolvable Attribute Device: Cloud disk or the device name of the mounted instance on the site.
attrDiskId @alicloud/ros-cdk-core.IResolvable Attribute DiskId: The disk id.
attrDiskName @alicloud/ros-cdk-core.IResolvable Attribute DiskName: The disk name.
attrEnableAutomatedSnapshotPolicy @alicloud/ros-cdk-core.IResolvable Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy.
attrEnableAutoSnapshot @alicloud/ros-cdk-core.IResolvable Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy.
attrEncrypted @alicloud/ros-cdk-core.IResolvable Attribute Encrypted: Whether the disk is encrypted.
attrExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: The expiration time of a monthly disk.
attrImageId @alicloud/ros-cdk-core.IResolvable Attribute ImageId: The image id.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The instance id.
attrIops @alicloud/ros-cdk-core.IResolvable Attribute Iops: Number of read/write (I/O) operations per second.
attrIopsRead @alicloud/ros-cdk-core.IResolvable Attribute IopsRead: Number of reads per second.
attrIopsWrite @alicloud/ros-cdk-core.IResolvable Attribute IopsWrite: Number of writes per second.
attrKmsKeyId @alicloud/ros-cdk-core.IResolvable Attribute KmsKeyId: The KMS keyId.
attrMountInstanceNum @alicloud/ros-cdk-core.IResolvable Attribute MountInstanceNum: Number of instances mounted on shared storage.
attrMountInstances @alicloud/ros-cdk-core.IResolvable Attribute MountInstances: Disk mount instances.
attrMultiAttach @alicloud/ros-cdk-core.IResolvable Attribute MultiAttach: Whether to enable the multi-Mount feature.
attrOperationLocks @alicloud/ros-cdk-core.IResolvable Attribute OperationLocks: Resource locking information.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: Payment method for disk.
attrPerformanceLevel @alicloud/ros-cdk-core.IResolvable Attribute PerformanceLevel: Performance levels of ESSD cloud disk.
attrPortable @alicloud/ros-cdk-core.IResolvable Attribute Portable: Whether the disk is unmountable.
attrProductCode @alicloud/ros-cdk-core.IResolvable Attribute ProductCode: The product logo of the cloud market.
attrProvisionedIops @alicloud/ros-cdk-core.IResolvable Attribute ProvisionedIops: The preconfigured read and write IOPS of the ESSD AutoPL cloud disk.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The resource group id.
attrSize @alicloud/ros-cdk-core.IResolvable Attribute Size: Disk size.
attrSnapshotId @alicloud/ros-cdk-core.IResolvable Attribute SnapshotId: The source snapshot id.
attrStorageClusterId @alicloud/ros-cdk-core.IResolvable Attribute StorageClusterId: The ID of the dedicated block storage cluster.
attrStorageSetId @alicloud/ros-cdk-core.IResolvable Attribute StorageSetId: The ID of the Save set.
attrStorageSetPartitionNumber @alicloud/ros-cdk-core.IResolvable Attribute StorageSetPartitionNumber: Number of Save set partitions.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: ID of the free zone to which the disk belongs.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAttachedTimeRequired 

public readonly attrAttachedTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AttachedTime: The attached time.

attrAutoSnapshotPolicyIdRequired 

public readonly attrAutoSnapshotPolicyId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.

attrBurstingEnabledRequired 

public readonly attrBurstingEnabled: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst).

attrCategoryRequired 

public readonly attrCategory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Category: Disk type.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time.

attrDeleteAutoSnapshotRequired 

public readonly attrDeleteAutoSnapshot: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time.

attrDeleteWithInstanceRequired 

public readonly attrDeleteWithInstance: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DeleteWithInstance: Whether to release with the instance.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description.

attrDetachedTimeRequired 

public readonly attrDetachedTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DetachedTime: Unloading time.

attrDeviceRequired 

public readonly attrDevice: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Device: Cloud disk or the device name of the mounted instance on the site.

attrDiskIdRequired 

public readonly attrDiskId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DiskId: The disk id.

attrDiskNameRequired 

public readonly attrDiskName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DiskName: The disk name.

attrEnableAutomatedSnapshotPolicyRequired 

public readonly attrEnableAutomatedSnapshotPolicy: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy.

attrEnableAutoSnapshotRequired 

public readonly attrEnableAutoSnapshot: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy.

attrEncryptedRequired 

public readonly attrEncrypted: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Encrypted: Whether the disk is encrypted.

attrExpiredTimeRequired 

public readonly attrExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: The expiration time of a monthly disk.

attrImageIdRequired 

public readonly attrImageId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageId: The image id.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The instance id.

attrIopsRequired 

public readonly attrIops: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Iops: Number of read/write (I/O) operations per second.

attrIopsReadRequired 

public readonly attrIopsRead: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IopsRead: Number of reads per second.

attrIopsWriteRequired 

public readonly attrIopsWrite: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IopsWrite: Number of writes per second.

attrKmsKeyIdRequired 

public readonly attrKmsKeyId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute KmsKeyId: The KMS keyId.

attrMountInstanceNumRequired 

public readonly attrMountInstanceNum: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MountInstanceNum: Number of instances mounted on shared storage.

attrMountInstancesRequired 

public readonly attrMountInstances: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MountInstances: Disk mount instances.

attrMultiAttachRequired 

public readonly attrMultiAttach: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MultiAttach: Whether to enable the multi-Mount feature.

attrOperationLocksRequired 

public readonly attrOperationLocks: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OperationLocks: Resource locking information.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: Payment method for disk.

attrPerformanceLevelRequired 

public readonly attrPerformanceLevel: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PerformanceLevel: Performance levels of ESSD cloud disk.

attrPortableRequired 

public readonly attrPortable: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Portable: Whether the disk is unmountable.

attrProductCodeRequired 

public readonly attrProductCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProductCode: The product logo of the cloud market.

attrProvisionedIopsRequired 

public readonly attrProvisionedIops: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProvisionedIops: The preconfigured read and write IOPS of the ESSD AutoPL cloud disk.

Possible values: 0 ~ min{50,000, 1000 * capacity-baseline performance}.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The resource group id.

attrSizeRequired 

public readonly attrSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Size: Disk size.

attrSnapshotIdRequired 

public readonly attrSnapshotId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SnapshotId: The source snapshot id.

attrStorageClusterIdRequired 

public readonly attrStorageClusterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageClusterId: The ID of the dedicated block storage cluster.

If you need to create a cloud disk in the specified dedicated block storage cluster, specify this parameter.

attrStorageSetIdRequired 

public readonly attrStorageSetId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageSetId: The ID of the Save set.

attrStorageSetPartitionNumberRequired 

public readonly attrStorageSetPartitionNumber: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageSetPartitionNumber: Number of Save set partitions.

Value range: greater than or equal to 2. The maximum value cannot exceed the equity quota limit displayed after calling.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: ID of the free zone to which the disk belongs.