Skip to content

Disk

This class encapsulates and extends the ROS resource type ALIYUN::ENS::Disk, which is used to create a pay-as-you-go or subscription data disk.

Initializers 

import ros_cdk_ens
ros_cdk_ens.Disk(
  scope: Construct,
  id: str,
  category: typing.Union[str, IResolvable],
  ens_region_id: typing.Union[str, IResolvable],
  instance_charge_type: typing.Union[str, IResolvable],
  size: typing.Union[str, IResolvable],
  disk_name: typing.Union[str, IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  snapshot_id: 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.
category typing.Union[str, ros_cdk_core.IResolvable] Property category: The category of the disk.
ens_region_id typing.Union[str, ros_cdk_core.IResolvable] Property ensRegionId: The ID of the edge node.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceChargeType: The billing method of the instance.
size typing.Union[str, ros_cdk_core.IResolvable] Property size: The size of the disk.
disk_name typing.Union[str, ros_cdk_core.IResolvable] Property diskName: The name of the disk.
encrypted typing.Union[bool, ros_cdk_core.IResolvable] Property encrypted: Specifies whether to encrypt the new system disk.
kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property kmsKeyId: The ID of the Key Management Service (KMS) key that is used by the cloud disk.
snapshot_id typing.Union[str, ros_cdk_core.IResolvable] Property snapshotId: The ID of the snapshot that you want to use to create the disk.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

categoryRequired

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

Property category: The category of the disk.

Valid values: cloud_efficiency: ultra disk. cloud_ssd: all-flash disk.

ens_region_idRequired

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

Property ensRegionId: The ID of the edge node.

instance_charge_typeRequired

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

Property instanceChargeType: The billing method of the instance.

Set the value to PostPaid.

sizeRequired

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

Property size: The size of the disk.

Unit: GiB.

disk_nameOptional

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

Property diskName: The name of the disk.

encryptedOptional

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

Property encrypted: Specifies whether to encrypt the new system disk.

Valid values: true false (default): no

kms_key_idOptional

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

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

Note If you set the Encrypted parameter to true, the default service key is used when the KMSKeyId parameter is empty.

snapshot_idOptional

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

Property snapshotId: The ID of the snapshot that you want to use to create the disk.

The following limits apply to the SnapshotId and Size parameters: If the size of the snapshot specified by SnapshotId is greater than the specified Size value, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by SnapshotId is smaller than the specified Size value, the size of the created disk is equal to the specified Size value.

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 

import ros_cdk_ens
ros_cdk_ens.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_disk_id ros_cdk_core.IResolvable Attribute DiskId: The ID of the instance.

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_disk_idRequired 

attr_disk_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskId: The ID of the instance.