Disk
- Implements: @alicloud/ros-cdk-ecs.datasource.IDisk
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
- Type: DiskProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute AttachedTime: The attached time. |
attrAutoSnapshotPolicyId | string | @alicloud/ros-cdk-core.IResolvable | Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID. |
attrBurstingEnabled | string | @alicloud/ros-cdk-core.IResolvable | Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst). |
attrCategory | string | @alicloud/ros-cdk-core.IResolvable | Attribute Category: Disk type. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time. |
attrDeleteAutoSnapshot | string | @alicloud/ros-cdk-core.IResolvable | Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time. |
attrDeleteWithInstance | string | @alicloud/ros-cdk-core.IResolvable | Attribute DeleteWithInstance: Whether to release with the instance. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The description. |
attrDetachedTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute DetachedTime: Unloading time. |
attrDevice | string | @alicloud/ros-cdk-core.IResolvable | Attribute Device: Cloud disk or the device name of the mounted instance on the site. |
attrDiskId | string | @alicloud/ros-cdk-core.IResolvable | Attribute DiskId: The disk id. |
attrDiskName | string | @alicloud/ros-cdk-core.IResolvable | Attribute DiskName: The disk name. |
attrEnableAutomatedSnapshotPolicy | string | @alicloud/ros-cdk-core.IResolvable | Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy. |
attrEnableAutoSnapshot | string | @alicloud/ros-cdk-core.IResolvable | Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy. |
attrEncrypted | string | @alicloud/ros-cdk-core.IResolvable | Attribute Encrypted: Whether the disk is encrypted. |
attrExpiredTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute ExpiredTime: The expiration time of a monthly disk. |
attrImageId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ImageId: The image id. |
attrInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute InstanceId: The instance id. |
attrIops | string | @alicloud/ros-cdk-core.IResolvable | Attribute Iops: Number of read/write (I/O) operations per second. |
attrIopsRead | string | @alicloud/ros-cdk-core.IResolvable | Attribute IopsRead: Number of reads per second. |
attrIopsWrite | string | @alicloud/ros-cdk-core.IResolvable | Attribute IopsWrite: Number of writes per second. |
attrKmsKeyId | string | @alicloud/ros-cdk-core.IResolvable | Attribute KmsKeyId: The KMS keyId. |
attrMountInstanceNum | string | @alicloud/ros-cdk-core.IResolvable | Attribute MountInstanceNum: Number of instances mounted on shared storage. |
attrMountInstances | string | @alicloud/ros-cdk-core.IResolvable | Attribute MountInstances: Disk mount instances. |
attrMultiAttach | string | @alicloud/ros-cdk-core.IResolvable | Attribute MultiAttach: Whether to enable the multi-Mount feature. |
attrOperationLocks | string | @alicloud/ros-cdk-core.IResolvable | Attribute OperationLocks: Resource locking information. |
attrPaymentType | string | @alicloud/ros-cdk-core.IResolvable | Attribute PaymentType: Payment method for disk. |
attrPerformanceLevel | string | @alicloud/ros-cdk-core.IResolvable | Attribute PerformanceLevel: Performance levels of ESSD cloud disk. |
attrPortable | string | @alicloud/ros-cdk-core.IResolvable | Attribute Portable: Whether the disk is unmountable. |
attrProductCode | string | @alicloud/ros-cdk-core.IResolvable | Attribute ProductCode: The product logo of the cloud market. |
attrProvisionedIops | string | @alicloud/ros-cdk-core.IResolvable | Attribute ProvisionedIops: The preconfigured read and write IOPS of the ESSD AutoPL cloud disk. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The resource group id. |
attrSize | string | @alicloud/ros-cdk-core.IResolvable | Attribute Size: Disk size. |
attrSnapshotId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SnapshotId: The source snapshot id. |
attrStorageClusterId | string | @alicloud/ros-cdk-core.IResolvable | Attribute StorageClusterId: The ID of the dedicated block storage cluster. |
attrStorageSetId | string | @alicloud/ros-cdk-core.IResolvable | Attribute StorageSetId: The ID of the Save set. |
attrStorageSetPartitionNumber | string | @alicloud/ros-cdk-core.IResolvable | Attribute StorageSetPartitionNumber: Number of Save set partitions. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tags. |
attrZoneId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ZoneId: ID of the free zone to which the disk belongs. |
props | DiskProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/ros-cdk-core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AttachedTime: The attached time.
attrAutoSnapshotPolicyIdRequired
public readonly attrAutoSnapshotPolicyId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.
attrBurstingEnabledRequired
public readonly attrBurstingEnabled: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst).
attrCategoryRequired
public readonly attrCategory: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Category: Disk type.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time.
attrDeleteAutoSnapshotRequired
public readonly attrDeleteAutoSnapshot: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time.
attrDeleteWithInstanceRequired
public readonly attrDeleteWithInstance: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DeleteWithInstance: Whether to release with the instance.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The description.
attrDetachedTimeRequired
public readonly attrDetachedTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DetachedTime: Unloading time.
attrDeviceRequired
public readonly attrDevice: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Device: Cloud disk or the device name of the mounted instance on the site.
attrDiskIdRequired
public readonly attrDiskId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DiskId: The disk id.
attrDiskNameRequired
public readonly attrDiskName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DiskName: The disk name.
attrEnableAutomatedSnapshotPolicyRequired
public readonly attrEnableAutomatedSnapshotPolicy: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy.
attrEnableAutoSnapshotRequired
public readonly attrEnableAutoSnapshot: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy.
attrEncryptedRequired
public readonly attrEncrypted: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Encrypted: Whether the disk is encrypted.
attrExpiredTimeRequired
public readonly attrExpiredTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ExpiredTime: The expiration time of a monthly disk.
attrImageIdRequired
public readonly attrImageId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ImageId: The image id.
attrInstanceIdRequired
public readonly attrInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InstanceId: The instance id.
attrIopsRequired
public readonly attrIops: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Iops: Number of read/write (I/O) operations per second.
attrIopsReadRequired
public readonly attrIopsRead: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IopsRead: Number of reads per second.
attrIopsWriteRequired
public readonly attrIopsWrite: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IopsWrite: Number of writes per second.
attrKmsKeyIdRequired
public readonly attrKmsKeyId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute KmsKeyId: The KMS keyId.
attrMountInstanceNumRequired
public readonly attrMountInstanceNum: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MountInstanceNum: Number of instances mounted on shared storage.
attrMountInstancesRequired
public readonly attrMountInstances: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MountInstances: Disk mount instances.
attrMultiAttachRequired
public readonly attrMultiAttach: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MultiAttach: Whether to enable the multi-Mount feature.
attrOperationLocksRequired
public readonly attrOperationLocks: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OperationLocks: Resource locking information.
attrPaymentTypeRequired
public readonly attrPaymentType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PaymentType: Payment method for disk.
attrPerformanceLevelRequired
public readonly attrPerformanceLevel: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PerformanceLevel: Performance levels of ESSD cloud disk.
attrPortableRequired
public readonly attrPortable: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Portable: Whether the disk is unmountable.
attrProductCodeRequired
public readonly attrProductCode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ProductCode: The product logo of the cloud market.
attrProvisionedIopsRequired
public readonly attrProvisionedIops: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The resource group id.
attrSizeRequired
public readonly attrSize: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Size: Disk size.
attrSnapshotIdRequired
public readonly attrSnapshotId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SnapshotId: The source snapshot id.
attrStorageClusterIdRequired
public readonly attrStorageClusterId: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute StorageSetId: The ID of the Save set.
attrStorageSetPartitionNumberRequired
public readonly attrStorageSetPartitionNumber: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tags.
attrZoneIdRequired
public readonly attrZoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ZoneId: ID of the free zone to which the disk belongs.
propsRequired
public readonly props: DiskProps;
- Type: DiskProps