Skip to content

Cluster

This class encapsulates and extends the ROS resource type ALIYUN::EMR::Cluster, which is used to create an E-MapReduce (EMR) cluster.

Initializers 

import ros_cdk_emr
ros_cdk_emr.Cluster(
  scope: Construct,
  id: str,
  charge_type: typing.Union[str, IResolvable],
  cluster_type: typing.Union[str, IResolvable],
  emr_ver: typing.Union[str, IResolvable],
  host_group: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, HostGroupProperty]]],
  name: typing.Union[str, IResolvable],
  net_type: typing.Union[str, IResolvable],
  use_local_meta_db: typing.Union[bool, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  authorize_content: typing.Union[str, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  bootstrap_action: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, BootstrapActionProperty]]] = None,
  click_house_conf: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  config: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ConfigProperty]]] = None,
  configurations: typing.Union[str, IResolvable] = None,
  deposit_type: typing.Union[str, IResolvable] = None,
  eas_enable: typing.Union[bool, IResolvable] = None,
  high_availability_enable: typing.Union[bool, IResolvable] = None,
  init_custom_hive_meta_db: typing.Union[bool, IResolvable] = None,
  instance_generation: typing.Union[str, IResolvable] = None,
  io_optimized: typing.Union[bool, IResolvable] = None,
  is_open_public_ip: typing.Union[bool, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  log_path: typing.Union[str, IResolvable] = None,
  machine_type: typing.Union[str, IResolvable] = None,
  master_pwd: typing.Union[str, IResolvable] = None,
  meta_store_conf: typing.Union[str, IResolvable] = None,
  meta_store_type: typing.Union[str, IResolvable] = None,
  option_soft_ware_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  related_cluster_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_name: typing.Union[str, IResolvable] = None,
  ssh_enable: typing.Union[bool, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  use_custom_hive_meta_db: typing.Union[bool, IResolvable] = None,
  user_defined_emr_ecs_role: typing.Union[str, IResolvable] = None,
  user_info: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, UserInfoProperty]]] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  white_list_type: 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.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method.
cluster_type typing.Union[str, ros_cdk_core.IResolvable] Property clusterType: The type of the cluster.
emr_ver typing.Union[str, ros_cdk_core.IResolvable] Property emrVer: The version of EMR.
host_group typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, HostGroupProperty]]] Property hostGroup:.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the cluster.
net_type typing.Union[str, ros_cdk_core.IResolvable] Property netType: The type of the network.
use_local_meta_db typing.Union[bool, ros_cdk_core.IResolvable] Property useLocalMetaDb: Indicates whether the local Hive metadatabase is used.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID.
authorize_content typing.Union[str, ros_cdk_core.IResolvable] Property authorizeContent: Not required.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Indicates whether the subscription cluster is auto-renewed.
bootstrap_action typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, BootstrapActionProperty]]] Property bootstrapAction:.
click_house_conf typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property clickHouseConf: undefined.
config typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ConfigProperty]]] Property config:.
configurations typing.Union[str, ros_cdk_core.IResolvable] Property configurations: Not required.
deposit_type typing.Union[str, ros_cdk_core.IResolvable] Property depositType: The hosting type.
eas_enable typing.Union[bool, ros_cdk_core.IResolvable] Property easEnable: Indicates whether the cluster is a high-security cluster.
high_availability_enable typing.Union[bool, ros_cdk_core.IResolvable] Property highAvailabilityEnable: Indicates whether the cluster is a high-availability cluster.
init_custom_hive_meta_db typing.Union[bool, ros_cdk_core.IResolvable] Property initCustomHiveMetaDb: A reserved parameter.
instance_generation typing.Union[str, ros_cdk_core.IResolvable] Property instanceGeneration: The generation of the ECS instances.
io_optimized typing.Union[bool, ros_cdk_core.IResolvable] Property ioOptimized: Indicates wether I\/O optimization is enabled.
is_open_public_ip typing.Union[bool, ros_cdk_core.IResolvable] Property isOpenPublicIp: Indicates whether a public IP address is assigned.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: The name of the key pair.
log_path typing.Union[str, ros_cdk_core.IResolvable] Property logPath: The log path in OSS.
machine_type typing.Union[str, ros_cdk_core.IResolvable] Property machineType: The type of the machine.
master_pwd typing.Union[str, ros_cdk_core.IResolvable] Property masterPwd: The SSH password for the master node.
meta_store_conf typing.Union[str, ros_cdk_core.IResolvable] Property metaStoreConf: Meta store conf of specific meta store type.
meta_store_type typing.Union[str, ros_cdk_core.IResolvable] Property metaStoreType: Meta store type.
option_soft_ware_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property optionSoftWareList: The list of optional services.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The length of the subscription.
related_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property relatedClusterId: The ID of the primary cluster (when the cluster that you create is a Gateway cluster).
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: The ID of the security group.
security_group_name typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupName: The name of the security group to create.
ssh_enable typing.Union[bool, ros_cdk_core.IResolvable] Property sshEnable: Indicates whether SSH is enabled.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
use_custom_hive_meta_db typing.Union[bool, ros_cdk_core.IResolvable] Property useCustomHiveMetaDb: A reserved parameter.
user_defined_emr_ecs_role typing.Union[str, ros_cdk_core.IResolvable] Property userDefinedEmrEcsRole: The role that is assigned to EMR for calling ECS resources.
user_info typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, UserInfoProperty]]] Property userInfo:.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the Vswitch.
white_list_type typing.Union[str, ros_cdk_core.IResolvable] Property whiteListType: Not required.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

charge_typeRequired

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

Property chargeType: The billing method.

Valid values: PostPaid and PrePaid. PostPaid: pay-as-you-go. PrePaid: subscription.

cluster_typeRequired

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

Property clusterType: The type of the cluster.

Allowd values: HADOOP, KAFKA, DRUID, ZOOKEEPER, DATA_SCIENCE, GATEWAY etc.

emr_verRequired

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

Property emrVer: The version of EMR.

host_groupRequired

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

Property hostGroup:.

nameRequired

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

Property name: The name of the cluster.

The name can be 1 to 64 characters in length and only contain Chinese characters, letters, numbers, hyphens (-), and underscores (_).

net_typeRequired

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

Property netType: The type of the network.

use_local_meta_dbRequired

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

Property useLocalMetaDb: Indicates whether the local Hive metadatabase is used.

zone_idRequired

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

Property zoneId: The zone ID.

authorize_contentOptional

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

Property authorizeContent: Not required.

auto_renewOptional

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

Property autoRenew: Indicates whether the subscription cluster is auto-renewed.

bootstrap_actionOptional

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

Property bootstrapAction:.

click_house_confOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property clickHouseConf: undefined.

configOptional

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

Property config:.

configurationsOptional

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

Property configurations: Not required.

deposit_typeOptional

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

Property depositType: The hosting type.

eas_enableOptional

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

Property easEnable: Indicates whether the cluster is a high-security cluster.

high_availability_enableOptional

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

Property highAvailabilityEnable: Indicates whether the cluster is a high-availability cluster.

A value of true indicates that two master nodes are required.

init_custom_hive_meta_dbOptional

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

Property initCustomHiveMetaDb: A reserved parameter.

Not required.

instance_generationOptional

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

Property instanceGeneration: The generation of the ECS instances.

io_optimizedOptional

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

Property ioOptimized: Indicates wether I\/O optimization is enabled.

Default value: true.

is_open_public_ipOptional

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

Property isOpenPublicIp: Indicates whether a public IP address is assigned.

A value of true indicates that a bandwidth of 8 MB is set by default.

key_pair_nameOptional

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

Property keyPairName: The name of the key pair.

log_pathOptional

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

Property logPath: The log path in OSS.

machine_typeOptional

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

Property machineType: The type of the machine.

master_pwdOptional

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

Property masterPwd: The SSH password for the master node.

The password must meet the following requirements. Length constraints: Minimum length of 8 characters. Maximum length of 30 characters. It must contain three types of characters (uppercase letters, lowercase letters, numbers, and special symbols).

meta_store_confOptional

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

Property metaStoreConf: Meta store conf of specific meta store type.

If MetaStoreType=user_rds, MetaStoreConf should be like {"dbUrl":"jdbc:mysql://xxxxxx", "dbUserName":"username", "dbPassword":"password"}

meta_store_typeOptional

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

Property metaStoreType: Meta store type.

Allow types: local: Local cluster unified: Unified meta data user_rds: User's RDS

option_soft_ware_listOptional

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

Property optionSoftWareList: The list of optional services.

periodOptional

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

Property period: The length of the subscription.

Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. A value is required when ChargeType=PrePaid.

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

Property relatedClusterId: The ID of the primary cluster (when the cluster that you create is a Gateway cluster).

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

security_group_idOptional

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

Property securityGroupId: The ID of the security group.

You can create a security group in the ECS console and use it. Note: If you use an existing security group, the default security group policy is applied to this security group: Only port 22 is open at the inbound and all ports are open at the outbound. You need to specify either SecurityGroupId or SecurityGroupName.

security_group_nameOptional

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

Property securityGroupName: The name of the security group to create.

If the ID of the security group is not specified, this name is used to create a new security group. After the cluster is created, you can view the ID of the security group on the Cluster Management page. The default security group policy is applied to this security group: Only port 22 is open at the inbound and all ports are open at the outbound. You need to specify either SecurityGroupId or SecurityGroupName.

ssh_enableOptional

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

Property sshEnable: Indicates whether SSH is enabled.

tagsOptional

Property tags: Tags to attach to instance.

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

use_custom_hive_meta_dbOptional

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

Property useCustomHiveMetaDb: A reserved parameter.

Not required.

user_defined_emr_ecs_roleOptional

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

Property userDefinedEmrEcsRole: The role that is assigned to EMR for calling ECS resources.

user_infoOptional

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

Property userInfo:.

vpc_idOptional

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

Property vpcId: The ID of the VPC.

A value is required when NetType=vpc.

v_switch_idOptional

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

Property vSwitchId: The ID of the Vswitch.

A value is required when NetType=vpc.

white_list_typeOptional

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

Property whiteListType: Not required.

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_emr
ros_cdk_emr.Cluster.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_cluster_id ros_cdk_core.IResolvable Attribute ClusterId: The ID of the cluster.
attr_host_groups ros_cdk_core.IResolvable Attribute HostGroups: The host group list of the cluster.
attr_master_node_inner_ips ros_cdk_core.IResolvable Attribute MasterNodeInnerIps: The inner ip list of the cluster master nodes.
attr_master_node_pub_ips ros_cdk_core.IResolvable Attribute MasterNodePubIps: The public ip list of the cluster master nodes.

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_cluster_idRequired 

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterId: The ID of the cluster.

attr_host_groupsRequired 

attr_host_groups: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HostGroups: The host group list of the cluster.

attr_master_node_inner_ipsRequired 

attr_master_node_inner_ips: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MasterNodeInnerIps: The inner ip list of the cluster master nodes.

attr_master_node_pub_ipsRequired 

attr_master_node_pub_ips: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MasterNodePubIps: The public ip list of the cluster master nodes.