Cluster

• Implements: ICluster

This class encapsulates and extends the ROS resource type ALIYUN::MSE::Cluster.

Initializers

import ros_cdk_mse
ros_cdk_mse.Cluster(
  scope: Construct,
  id: str,
  cluster_specification: typing.Union[str, IResolvable],
  cluster_type: typing.Union[str, IResolvable],
  cluster_version: typing.Union[str, IResolvable],
  instance_count: typing.Union[typing.Union[int, float], IResolvable],
  net_type: typing.Union[str, IResolvable],
  acl_entry_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  cluster_alias_name: typing.Union[str, IResolvable] = None,
  connection_type: typing.Union[str, IResolvable] = None,
  eip_enabled: typing.Union[bool, IResolvable] = None,
  mse_version: typing.Union[str, IResolvable] = None,
  pub_network_flow: typing.Union[typing.Union[int, float], IResolvable] = None,
  request_pars: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

cluster_specification^Required

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

Property clusterSpecification: Engine specification.

[Professional Edition]

• MSE_SC_2_4_60_c: 2 cores 4GB
• MSE_SC_1_2_60_c: 1 core 2GB
• MSE_SC_4_8_60_c: 4 cores 8GB
• MSE_SC_8_16_60_c: 8 cores 16GB
• MSE_SC_16_32_60_c: 16 cores 32GB

[Development Edition]

• MSE_SC_1_2_60_c: 1 core 2GB
• MSE_SC_2_4_60_c: 2 cores 4GB

[Serverless Edition]

• Ignore this parameter or fill with MSE_SC_SERVERLESS.

cluster_type^Required

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

Property clusterType: Cluster type, including ZooKeeper, Nacos-Ans.

cluster_version^Required

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

Property clusterVersion: Cluster version.

[Professional Edition]

• NACOS_2_0_0: Nacos 2.x.x version.
• ZooKeeper_3_8_0: ZooKeeper 3.8.x version.

[Development Edition]

• NACOS_2_0_0: Nacos 2.x version.
• ZooKeeper_3_8_0: ZooKeeper 3.8.x version.

[Serverless Edition]

• NACOS_2_0_0: Nacos 2.x version.
• ZooKeeper_3_8_0: ZooKeeper 3.8.x version.

instance_count^Required

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

Property instanceCount: Number of instance nodes. Range: 1~15.

[Professional Edition]

• Must be >=3 and odd number.

[Development Edition]

• Only 1 allowed.

[Serverless Edition]

• Ignore this parameter.

net_type^Required

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

Property netType: Network type.

Valid values:

• privatenet: Private network.
• pubnet: Public network.

acl_entry_list^Optional

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

Property aclEntryList: List of ACL entries.

charge_type^Optional

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

Property chargeType: Billing mode, including PREPAY (annual\/monthly) and POSTPAY (pay-as-you-go).

Ignored for Serverless Edition.

cluster_alias_name^Optional

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

Property clusterAliasName: cluster alias name.

connection_type^Optional

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

Property connectionType: Network access type, slb or single_eni;

some regions only support single_eni for Development Edition.

eip_enabled^Optional

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

Property eipEnabled: Effective when ConnectionType is single_eni, indicates whether to enable public access (elastic IP).

mse_version^Optional

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

Property mseVersion: Must be filled unless special circumstances.

Valid values:

• mse_pro: Professional Edition.
• mse_dev: Development Edition.
• mse_serverless: Serverless Edition.

pub_network_flow^Optional

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

Property pubNetworkFlow: Public network flow.

Valid when ConnectionType is slb. 0 means do not create public SLB; 1 or above indicates fixed bandwidth value in Mbps. Range: 0~5000.

request_pars^Optional

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

Property requestPars: Extended request parameters in JSON format.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

security_group_type^Optional

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

Property securityGroupType: Effective when ConnectionType is single_eni, represents the security group type of the instance.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to cluster.

Max support 20 tags to add during create cluster. Each tag with two properties Key and Value, and Key is required.

vpc_id^Optional

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

Property vpcId: VPC ID.

v_switch_id^Optional

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

Property vSwitchId: Switch ID.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_mse
ros_cdk_mse.Cluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_acl_entry_list^Required

attr_acl_entry_list: typing.Union[str, IResolvable]

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

Attribute AclEntryList: The list of ACL entries.

attr_acl_id^Required

attr_acl_id: typing.Union[str, IResolvable]

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

Attribute AclId: The ID of the ACL.

attr_app_version^Required

attr_app_version: typing.Union[str, IResolvable]

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

Attribute AppVersion: The version of the application.

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_cluster_alias_name^Required

attr_cluster_alias_name: typing.Union[str, IResolvable]

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

Attribute ClusterAliasName: The alias name of the cluster.

attr_cluster_id^Required

attr_cluster_id: typing.Union[str, IResolvable]

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

Attribute ClusterId: The ID of the cluster.

attr_cluster_name^Required

attr_cluster_name: typing.Union[str, IResolvable]

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

Attribute ClusterName: The name of the cluster.

attr_cluster_specification^Required

attr_cluster_specification: typing.Union[str, IResolvable]

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

Attribute ClusterSpecification: The specification of the cluster.

attr_cluster_type^Required

attr_cluster_type: typing.Union[str, IResolvable]

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

Attribute ClusterType: The type of the cluster.

attr_cluster_version^Required

attr_cluster_version: typing.Union[str, IResolvable]

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

Attribute ClusterVersion: The version of the cluster.

attr_config_auth_enabled^Required

attr_config_auth_enabled: typing.Union[str, IResolvable]

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

Attribute ConfigAuthEnabled: Whether to enable the configuration authentication.

attr_config_secret_enabled^Required

attr_config_secret_enabled: typing.Union[str, IResolvable]

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

Attribute ConfigSecretEnabled: Whether to enable the configuration secret.

attr_connection_type^Required

attr_connection_type: typing.Union[str, IResolvable]

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

Attribute ConnectionType: The connection type.

attr_cpu^Required

attr_cpu: typing.Union[str, IResolvable]

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

Attribute Cpu: The number of CPU cores.

attr_disk_capacity^Required

attr_disk_capacity: typing.Union[str, IResolvable]

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

Attribute DiskCapacity: The disk capacity.

attr_disk_type^Required

attr_disk_type: typing.Union[str, IResolvable]

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

Attribute DiskType: The disk type.

attr_health_status^Required

attr_health_status: typing.Union[str, IResolvable]

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

Attribute HealthStatus: The health status of the cluster.

attr_instance_count^Required

attr_instance_count: typing.Union[str, IResolvable]

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

Attribute InstanceCount: The number of instances.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: The ID of the cluster instance.

attr_internet_address^Required

attr_internet_address: typing.Union[str, IResolvable]

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

Attribute InternetAddress: The public network address of the cluster.

attr_internet_domain^Required

attr_internet_domain: typing.Union[str, IResolvable]

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

Attribute InternetDomain: The public network domain of the cluster.

attr_internet_port^Required

attr_internet_port: typing.Union[str, IResolvable]

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

Attribute InternetPort: The public network port of the cluster.

attr_intranet_address^Required

attr_intranet_address: typing.Union[str, IResolvable]

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

Attribute IntranetAddress: The intranet address of the cluster.

attr_intranet_domain^Required

attr_intranet_domain: typing.Union[str, IResolvable]

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

Attribute IntranetDomain: The intranet domain of the cluster.

attr_intranet_port^Required

attr_intranet_port: typing.Union[str, IResolvable]

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

Attribute IntranetPort: The intranet port of the cluster.

attr_mcp_enabled^Required

attr_mcp_enabled: typing.Union[str, IResolvable]

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

Attribute MCPEnabled: Whether to enable the MCP.

attr_memory_capacity^Required

attr_memory_capacity: typing.Union[str, IResolvable]

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

Attribute MemoryCapacity: The memory capacity.

attr_mse_version^Required

attr_mse_version: typing.Union[str, IResolvable]

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

Attribute MseVersion: The MSE version.

attr_net_type^Required

attr_net_type: typing.Union[str, IResolvable]

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

Attribute NetType: The network type.

attr_pay_info^Required

attr_pay_info: typing.Union[str, IResolvable]

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

Attribute PayInfo: The payment information.

attr_pub_network_flow^Required

attr_pub_network_flow: typing.Union[str, IResolvable]

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

Attribute PubNetworkFlow: The public network flow.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The ID of the VPC.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The ID of the VSwitch.

props^Required

props: ClusterProps

• Type: ClusterProps