Skip to content

IDBCluster

Represents a DBCluster.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_ali_uid typing.Union[str, ros_cdk_core.IResolvable] Attribute AliUid: AliUid.
attr_bid typing.Union[str, ros_cdk_core.IResolvable] Attribute Bid: BusinessID.
attr_category typing.Union[str, ros_cdk_core.IResolvable] Attribute Category: The edition of the cluster.
attr_commodity_code typing.Union[str, ros_cdk_core.IResolvable] Attribute CommodityCode: Product Code.
attr_connection_string typing.Union[str, ros_cdk_core.IResolvable] Attribute ConnectionString: ConnectionString.
attr_db_cluster_description typing.Union[str, ros_cdk_core.IResolvable] Attribute DBClusterDescription: The description of the cluster.
attr_db_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Attribute DBClusterId: The id of DBCluster.
attr_db_cluster_network_type typing.Union[str, ros_cdk_core.IResolvable] Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.
attr_db_cluster_type typing.Union[str, ros_cdk_core.IResolvable] Attribute DBClusterType: The specification of the cluster.
attr_db_cluster_version typing.Union[str, ros_cdk_core.IResolvable] Attribute DBClusterVersion: Version, value: 19.15.2.2.
attr_db_node_class typing.Union[str, ros_cdk_core.IResolvable] Attribute DBNodeClass: DBNodeClass.
attr_db_node_count typing.Union[str, ros_cdk_core.IResolvable] Attribute DBNodeCount: The number of nodes.
attr_db_node_storage typing.Union[str, ros_cdk_core.IResolvable] Attribute DBNodeStorage: The storage capacity of a single node.
attr_db_node_storage_type typing.Union[str, ros_cdk_core.IResolvable] Attribute DbNodeStorageType: Instance node storage type.
attr_encryption_key typing.Union[str, ros_cdk_core.IResolvable] Attribute EncryptionKey: KMS key ID.
attr_encryption_type typing.Union[str, ros_cdk_core.IResolvable] Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
attr_engine typing.Union[str, ros_cdk_core.IResolvable] Attribute Engine: Engine.
attr_engine_version typing.Union[str, ros_cdk_core.IResolvable] Attribute EngineVersion: EngineVersion.
attr_is_expired typing.Union[str, ros_cdk_core.IResolvable] Attribute IsExpired: IsExpired.
attr_lock_mode typing.Union[str, ros_cdk_core.IResolvable] Attribute LockMode: LockMode.
attr_lock_reason typing.Union[str, ros_cdk_core.IResolvable] Attribute LockReason: Reason for lock.
attr_payment_type typing.Union[str, ros_cdk_core.IResolvable] Attribute PaymentType: PayType.
attr_period typing.Union[str, ros_cdk_core.IResolvable] Attribute Period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.
attr_port typing.Union[str, ros_cdk_core.IResolvable] Attribute Port: Connection port.
attr_public_connection_string typing.Union[str, ros_cdk_core.IResolvable] Attribute PublicConnectionString: Internet connection address.
attr_public_port typing.Union[str, ros_cdk_core.IResolvable] Attribute PublicPort: PublicPort.
attr_storage_type typing.Union[str, ros_cdk_core.IResolvable] Attribute StorageType: StorageType.
attr_vpc_cloud_instance_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VpcCloudInstanceId: VpcCloudInstanceId.
attr_vpc_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VpcId: VpcId.
attr_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VSwitchId: VSwitchId.
attr_zone_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ZoneId: ZoneId.
props DBClusterProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

env: IResourceEnvironment
  • Type: 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.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_ali_uidRequired

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

Attribute AliUid: AliUid.


attr_bidRequired

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

Attribute Bid: BusinessID.


attr_categoryRequired

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

Attribute Category: The edition of the cluster.


attr_commodity_codeRequired

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

Attribute CommodityCode: Product Code.


attr_connection_stringRequired

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

Attribute ConnectionString: ConnectionString.


attr_db_cluster_descriptionRequired

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

Attribute DBClusterDescription: The description of the cluster.


attr_db_cluster_idRequired

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

Attribute DBClusterId: The id of DBCluster.


attr_db_cluster_network_typeRequired

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

Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.


attr_db_cluster_typeRequired

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

Attribute DBClusterType: The specification of the cluster.


attr_db_cluster_versionRequired

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

Attribute DBClusterVersion: Version, value: 19.15.2.2.


attr_db_node_classRequired

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

Attribute DBNodeClass: DBNodeClass.


attr_db_node_countRequired

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

Attribute DBNodeCount: The number of nodes.


attr_db_node_storageRequired

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

Attribute DBNodeStorage: The storage capacity of a single node.


attr_db_node_storage_typeRequired

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

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.


attr_encryption_keyRequired

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

Attribute EncryptionKey: KMS key ID.


attr_encryption_typeRequired

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

Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.


attr_engineRequired

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

Attribute Engine: Engine.


attr_engine_versionRequired

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

Attribute EngineVersion: EngineVersion.


attr_is_expiredRequired

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

Attribute IsExpired: IsExpired.


attr_lock_modeRequired

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

Attribute LockMode: LockMode.


attr_lock_reasonRequired

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

Attribute LockReason: Reason for lock.


attr_payment_typeRequired

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

Attribute PaymentType: PayType.


attr_periodRequired

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

Attribute Period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.


attr_portRequired

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

Attribute Port: Connection port.


attr_public_connection_stringRequired

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

Attribute PublicConnectionString: Internet connection address.


attr_public_portRequired

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

Attribute PublicPort: PublicPort.


attr_storage_typeRequired

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

Attribute StorageType: StorageType.


attr_vpc_cloud_instance_idRequired

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

Attribute VpcCloudInstanceId: VpcCloudInstanceId.


attr_vpc_idRequired

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

Attribute VpcId: VpcId.


attr_v_switch_idRequired

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

Attribute VSwitchId: VSwitchId.


attr_zone_idRequired

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

Attribute ZoneId: ZoneId.


propsRequired

props: DBClusterProps