Skip to content

Disk

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Disk, which is used to query the information about a cloud disk.

Initializers 

from ros_cdk_ecs import datasource
datasource.Disk(
  scope: Construct,
  id: str,
  disk_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
disk_id typing.Union[str, ros_cdk_core.IResolvable] Property diskId: The disk id.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

disk_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property diskId: The disk id.

refresh_optionsOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

from ros_cdk_ecs import datasource
datasource.Disk.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_attached_time ros_cdk_core.IResolvable Attribute AttachedTime: The attached time.
attr_auto_snapshot_policy_id ros_cdk_core.IResolvable Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.
attr_bursting_enabled ros_cdk_core.IResolvable Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst).
attr_category ros_cdk_core.IResolvable Attribute Category: Disk type.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time.
attr_delete_auto_snapshot ros_cdk_core.IResolvable Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time.
attr_delete_with_instance ros_cdk_core.IResolvable Attribute DeleteWithInstance: Whether to release with the instance.
attr_description ros_cdk_core.IResolvable Attribute Description: The description.
attr_detached_time ros_cdk_core.IResolvable Attribute DetachedTime: Unloading time.
attr_device ros_cdk_core.IResolvable Attribute Device: Cloud disk or the device name of the mounted instance on the site.
attr_disk_id ros_cdk_core.IResolvable Attribute DiskId: The disk id.
attr_disk_name ros_cdk_core.IResolvable Attribute DiskName: The disk name.
attr_enable_automated_snapshot_policy ros_cdk_core.IResolvable Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy.
attr_enable_auto_snapshot ros_cdk_core.IResolvable Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy.
attr_encrypted ros_cdk_core.IResolvable Attribute Encrypted: Whether the disk is encrypted.
attr_expired_time ros_cdk_core.IResolvable Attribute ExpiredTime: The expiration time of a monthly disk.
attr_image_id ros_cdk_core.IResolvable Attribute ImageId: The image id.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The instance id.
attr_iops ros_cdk_core.IResolvable Attribute Iops: Number of read/write (I/O) operations per second.
attr_iops_read ros_cdk_core.IResolvable Attribute IopsRead: Number of reads per second.
attr_iops_write ros_cdk_core.IResolvable Attribute IopsWrite: Number of writes per second.
attr_kms_key_id ros_cdk_core.IResolvable Attribute KmsKeyId: The KMS keyId.
attr_mount_instance_num ros_cdk_core.IResolvable Attribute MountInstanceNum: Number of instances mounted on shared storage.
attr_mount_instances ros_cdk_core.IResolvable Attribute MountInstances: Disk mount instances.
attr_multi_attach ros_cdk_core.IResolvable Attribute MultiAttach: Whether to enable the multi-Mount feature.
attr_operation_locks ros_cdk_core.IResolvable Attribute OperationLocks: Resource locking information.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: Payment method for disk.
attr_performance_level ros_cdk_core.IResolvable Attribute PerformanceLevel: Performance levels of ESSD cloud disk.
attr_portable ros_cdk_core.IResolvable Attribute Portable: Whether the disk is unmountable.
attr_product_code ros_cdk_core.IResolvable Attribute ProductCode: The product logo of the cloud market.
attr_provisioned_iops ros_cdk_core.IResolvable Attribute ProvisionedIops: The preconfigured read and write IOPS of the ESSD AutoPL cloud disk.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The resource group id.
attr_size ros_cdk_core.IResolvable Attribute Size: Disk size.
attr_snapshot_id ros_cdk_core.IResolvable Attribute SnapshotId: The source snapshot id.
attr_storage_cluster_id ros_cdk_core.IResolvable Attribute StorageClusterId: The ID of the dedicated block storage cluster.
attr_storage_set_id ros_cdk_core.IResolvable Attribute StorageSetId: The ID of the Save set.
attr_storage_set_partition_number ros_cdk_core.IResolvable Attribute StorageSetPartitionNumber: Number of Save set partitions.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tags.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: ID of the free zone to which the disk belongs.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_attached_timeRequired 

attr_attached_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AttachedTime: The attached time.

attr_auto_snapshot_policy_idRequired 

attr_auto_snapshot_policy_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.

attr_bursting_enabledRequired 

attr_bursting_enabled: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_categoryRequired 

attr_category: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Category: Disk type.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time.

attr_delete_auto_snapshotRequired 

attr_delete_auto_snapshot: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_delete_with_instanceRequired 

attr_delete_with_instance: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DeleteWithInstance: Whether to release with the instance.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description.

attr_detached_timeRequired 

attr_detached_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DetachedTime: Unloading time.

attr_deviceRequired 

attr_device: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_disk_idRequired 

attr_disk_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskId: The disk id.

attr_disk_nameRequired 

attr_disk_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskName: The disk name.

attr_enable_automated_snapshot_policyRequired 

attr_enable_automated_snapshot_policy: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_enable_auto_snapshotRequired 

attr_enable_auto_snapshot: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_encryptedRequired 

attr_encrypted: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Encrypted: Whether the disk is encrypted.

attr_expired_timeRequired 

attr_expired_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpiredTime: The expiration time of a monthly disk.

attr_image_idRequired 

attr_image_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageId: The image id.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The instance id.

attr_iopsRequired 

attr_iops: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_iops_readRequired 

attr_iops_read: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IopsRead: Number of reads per second.

attr_iops_writeRequired 

attr_iops_write: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IopsWrite: Number of writes per second.

attr_kms_key_idRequired 

attr_kms_key_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute KmsKeyId: The KMS keyId.

attr_mount_instance_numRequired 

attr_mount_instance_num: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MountInstanceNum: Number of instances mounted on shared storage.

attr_mount_instancesRequired 

attr_mount_instances: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MountInstances: Disk mount instances.

attr_multi_attachRequired 

attr_multi_attach: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_operation_locksRequired 

attr_operation_locks: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OperationLocks: Resource locking information.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: Payment method for disk.

attr_performance_levelRequired 

attr_performance_level: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PerformanceLevel: Performance levels of ESSD cloud disk.

attr_portableRequired 

attr_portable: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Portable: Whether the disk is unmountable.

attr_product_codeRequired 

attr_product_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProductCode: The product logo of the cloud market.

attr_provisioned_iopsRequired 

attr_provisioned_iops: IResolvable
  • Type: 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}.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The resource group id.

attr_sizeRequired 

attr_size: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Size: Disk size.

attr_snapshot_idRequired 

attr_snapshot_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SnapshotId: The source snapshot id.

attr_storage_cluster_idRequired 

attr_storage_cluster_id: IResolvable
  • Type: 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.

attr_storage_set_idRequired 

attr_storage_set_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StorageSetId: The ID of the Save set.

attr_storage_set_partition_numberRequired 

attr_storage_set_partition_number: IResolvable
  • Type: 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.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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