Skip to content

Cluster

This class encapsulates and extends the ROS resource type ALIYUN::MSE::ClusterUse , which to create a cluster.

Initializers

import com.aliyun.ros.cdk.mse.Cluster;
Cluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .clusterSpecification(java.lang.String)
    .clusterSpecification(IResolvable)
    .clusterType(java.lang.String)
    .clusterType(IResolvable)
    .clusterVersion(java.lang.String)
    .clusterVersion(IResolvable)
    .instanceCount(java.lang.Number)
    .instanceCount(IResolvable)
    .netType(java.lang.String)
    .netType(IResolvable)
//  .aclEntryList(IResolvable)
//  .aclEntryList(java.util.List<java.lang.String)
//  .aclEntryList(IResolvable>)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .clusterAliasName(java.lang.String)
//  .clusterAliasName(IResolvable)
//  .connectionType(java.lang.String)
//  .connectionType(IResolvable)
//  .eipEnabled(java.lang.Boolean)
//  .eipEnabled(IResolvable)
//  .mseVersion(java.lang.String)
//  .mseVersion(IResolvable)
//  .pubNetworkFlow(java.lang.Number)
//  .pubNetworkFlow(IResolvable)
//  .requestPars(java.lang.String)
//  .requestPars(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityGroupType(java.lang.String)
//  .securityGroupType(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
clusterSpecification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterSpecification: Engine specification.
clusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterType: Cluster type, including ZooKeeper, Nacos-Ans.
clusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterVersion: Cluster version.
instanceCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property instanceCount: Number of instance nodes, with a range limit of 1 to 9.
netType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property netType: Network type.
aclEntryList com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property aclEntryList: List of ACL entries.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: Billing mode, including PREPAY (annual\/monthly) and POSTPAY (pay-as-you-go).
clusterAliasName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterAliasName: cluster alias name.
connectionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionType: Network access type, slb or single_eni;
eipEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property eipEnabled: Valid when ConnectionType is single_eni, indicating whether to enable public network access (Elastic IP).
mseVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property mseVersion: Must be filled unless special circumstances.
pubNetworkFlow java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property pubNetworkFlow: Public network flow.
requestPars java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property requestPars: Extended request parameters in JSON format.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
securityGroupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupType: Valid when ConnectionType is single_eni, indicating the security group type of the instance.
tags java.util.List<TagsProperty> Property tags: Tags to attach to cluster.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VPC ID.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: Switch ID.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

clusterSpecificationRequired

  • Type: java.lang.String OR com.aliyun.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.

clusterTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


clusterVersionRequired

  • Type: java.lang.String OR com.aliyun.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.

instanceCountRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property instanceCount: Number of instance nodes, with a range limit of 1 to 9.

[Professional Edition]

  • The number of instances must be 3 or more and must be an odd number. [Developer Edition]
  • The number of instances can only be 1. [Serverless Edition] Ignore this parameter.

netTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property netType: Network type.

Valid values:

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

aclEntryListOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property aclEntryList: List of ACL entries.


chargeTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Ignored for Serverless Edition.


clusterAliasNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property clusterAliasName: cluster alias name.


connectionTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property connectionType: Network access type, slb or single_eni;

some regions only support single_eni for Development Edition.


eipEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property eipEnabled: Valid when ConnectionType is single_eni, indicating whether to enable public network access (Elastic IP).


mseVersionOptional

  • Type: java.lang.String OR com.aliyun.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.

pubNetworkFlowOptional

  • Type: java.lang.Number OR com.aliyun.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.


requestParsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property requestPars: Extended request parameters in JSON format.


resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.


securityGroupTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityGroupType: Valid when ConnectionType is single_eni, indicating the security group type of the instance.


tagsOptional

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.


vpcIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: VPC ID.


vSwitchIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: Switch ID.


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 java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.mse.Cluster;
Cluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAclEntryList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclEntryList: The list of ACL entries.
attrAclId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclId: The ID of the ACL.
attrAppVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AppVersion: The version of the application.
attrArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attrClusterAliasName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterAliasName: The alias name of the cluster.
attrClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterId: The ID of the cluster.
attrClusterName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterName: The name of the cluster.
attrClusterSpecification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterSpecification: The specification of the cluster.
attrClusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterType: The type of the cluster.
attrClusterVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClusterVersion: The version of the cluster.
attrConfigAuthEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigAuthEnabled: Whether to enable the configuration authentication.
attrConfigSecretEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigSecretEnabled: Whether to enable the configuration secret.
attrConnectionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionType: The connection type.
attrCpu java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Cpu: The number of CPU cores.
attrDiskCapacity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DiskCapacity: The disk capacity.
attrDiskType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DiskType: The disk type.
attrHealthStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthStatus: The health status of the cluster.
attrInstanceCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceCount: The number of instances.
attrInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the cluster instance.
attrInternetAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InternetAddress: The public network address of the cluster.
attrInternetDomain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InternetDomain: The public network domain of the cluster.
attrInternetPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InternetPort: The public network port of the cluster.
attrIntranetAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IntranetAddress: The intranet address of the cluster.
attrIntranetDomain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IntranetDomain: The intranet domain of the cluster.
attrIntranetPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IntranetPort: The intranet port of the cluster.
attrMcpEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MCPEnabled: Whether to enable the MCP.
attrMemoryCapacity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MemoryCapacity: The memory capacity.
attrMseVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MseVersion: The MSE version.
attrNetType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NetType: The network type.
attrPayInfo java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PayInfo: The payment information.
attrPubNetworkFlow java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PubNetworkFlow: The public network flow.
attrVpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: The ID of the VPC.
attrVSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: The ID of the VSwitch.
props ClusterProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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 java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAclEntryListRequired

public java.lang.Object getAttrAclEntryList();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AclEntryList: The list of ACL entries.


attrAclIdRequired

public java.lang.Object getAttrAclId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AclId: The ID of the ACL.


attrAppVersionRequired

public java.lang.Object getAttrAppVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AppVersion: The version of the application.


attrArnRequired

public java.lang.Object getAttrArn();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrClusterAliasNameRequired

public java.lang.Object getAttrClusterAliasName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterAliasName: The alias name of the cluster.


attrClusterIdRequired

public java.lang.Object getAttrClusterId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: The ID of the cluster.


attrClusterNameRequired

public java.lang.Object getAttrClusterName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterName: The name of the cluster.


attrClusterSpecificationRequired

public java.lang.Object getAttrClusterSpecification();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterSpecification: The specification of the cluster.


attrClusterTypeRequired

public java.lang.Object getAttrClusterType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterType: The type of the cluster.


attrClusterVersionRequired

public java.lang.Object getAttrClusterVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterVersion: The version of the cluster.


attrConfigAuthEnabledRequired

public java.lang.Object getAttrConfigAuthEnabled();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigAuthEnabled: Whether to enable the configuration authentication.


attrConfigSecretEnabledRequired

public java.lang.Object getAttrConfigSecretEnabled();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigSecretEnabled: Whether to enable the configuration secret.


attrConnectionTypeRequired

public java.lang.Object getAttrConnectionType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionType: The connection type.


attrCpuRequired

public java.lang.Object getAttrCpu();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Cpu: The number of CPU cores.


attrDiskCapacityRequired

public java.lang.Object getAttrDiskCapacity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DiskCapacity: The disk capacity.


attrDiskTypeRequired

public java.lang.Object getAttrDiskType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DiskType: The disk type.


attrHealthStatusRequired

public java.lang.Object getAttrHealthStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthStatus: The health status of the cluster.


attrInstanceCountRequired

public java.lang.Object getAttrInstanceCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceCount: The number of instances.


attrInstanceIdRequired

public java.lang.Object getAttrInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the cluster instance.


attrInternetAddressRequired

public java.lang.Object getAttrInternetAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InternetAddress: The public network address of the cluster.


attrInternetDomainRequired

public java.lang.Object getAttrInternetDomain();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InternetDomain: The public network domain of the cluster.


attrInternetPortRequired

public java.lang.Object getAttrInternetPort();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InternetPort: The public network port of the cluster.


attrIntranetAddressRequired

public java.lang.Object getAttrIntranetAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IntranetAddress: The intranet address of the cluster.


attrIntranetDomainRequired

public java.lang.Object getAttrIntranetDomain();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IntranetDomain: The intranet domain of the cluster.


attrIntranetPortRequired

public java.lang.Object getAttrIntranetPort();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IntranetPort: The intranet port of the cluster.


attrMcpEnabledRequired

public java.lang.Object getAttrMcpEnabled();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MCPEnabled: Whether to enable the MCP.


attrMemoryCapacityRequired

public java.lang.Object getAttrMemoryCapacity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MemoryCapacity: The memory capacity.


attrMseVersionRequired

public java.lang.Object getAttrMseVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MseVersion: The MSE version.


attrNetTypeRequired

public java.lang.Object getAttrNetType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetType: The network type.


attrPayInfoRequired

public java.lang.Object getAttrPayInfo();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PayInfo: The payment information.


attrPubNetworkFlowRequired

public java.lang.Object getAttrPubNetworkFlow();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PubNetworkFlow: The public network flow.


attrVpcIdRequired

public java.lang.Object getAttrVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The ID of the VPC.


attrVSwitchIdRequired

public java.lang.Object getAttrVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The ID of the VSwitch.


propsRequired

public ClusterProps getProps();