Skip to content

ClusterProps

Properties for defining a Cluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-emr-cluster

Initializer 

import { ClusterProps } from '@alicloud/ros-cdk-emr'
const clusterProps: ClusterProps = { ... }

Properties

Name Type Description
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method.
clusterType string | @alicloud/ros-cdk-core.IResolvable Property clusterType: The type of the cluster.
emrVer string | @alicloud/ros-cdk-core.IResolvable Property emrVer: The version of EMR.
hostGroup @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | HostGroupProperty[] Property hostGroup:.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the cluster.
netType string | @alicloud/ros-cdk-core.IResolvable Property netType: The type of the network.
useLocalMetaDb boolean | @alicloud/ros-cdk-core.IResolvable Property useLocalMetaDb: Indicates whether the local Hive metadatabase is used.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID.
authorizeContent string | @alicloud/ros-cdk-core.IResolvable Property authorizeContent: Not required.
autoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Indicates whether the subscription cluster is auto-renewed.
bootstrapAction @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | BootstrapActionProperty[] Property bootstrapAction:.
clickHouseConf @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property clickHouseConf: undefined.
config @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ConfigProperty[] Property config:.
configurations string | @alicloud/ros-cdk-core.IResolvable Property configurations: Not required.
depositType string | @alicloud/ros-cdk-core.IResolvable Property depositType: The hosting type.
easEnable boolean | @alicloud/ros-cdk-core.IResolvable Property easEnable: Indicates whether the cluster is a high-security cluster.
highAvailabilityEnable boolean | @alicloud/ros-cdk-core.IResolvable Property highAvailabilityEnable: Indicates whether the cluster is a high-availability cluster.
initCustomHiveMetaDb boolean | @alicloud/ros-cdk-core.IResolvable Property initCustomHiveMetaDb: A reserved parameter.
instanceGeneration string | @alicloud/ros-cdk-core.IResolvable Property instanceGeneration: The generation of the ECS instances.
ioOptimized boolean | @alicloud/ros-cdk-core.IResolvable Property ioOptimized: Indicates wether I\/O optimization is enabled.
isOpenPublicIp boolean | @alicloud/ros-cdk-core.IResolvable Property isOpenPublicIp: Indicates whether a public IP address is assigned.
keyPairName string | @alicloud/ros-cdk-core.IResolvable Property keyPairName: The name of the key pair.
logPath string | @alicloud/ros-cdk-core.IResolvable Property logPath: The log path in OSS.
machineType string | @alicloud/ros-cdk-core.IResolvable Property machineType: The type of the machine.
masterPwd string | @alicloud/ros-cdk-core.IResolvable Property masterPwd: The SSH password for the master node.
metaStoreConf string | @alicloud/ros-cdk-core.IResolvable Property metaStoreConf: Meta store conf of specific meta store type.
metaStoreType string | @alicloud/ros-cdk-core.IResolvable Property metaStoreType: Meta store type.
optionSoftWareList @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property optionSoftWareList: The list of optional services.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The length of the subscription.
relatedClusterId string | @alicloud/ros-cdk-core.IResolvable Property relatedClusterId: The ID of the primary cluster (when the cluster that you create is a Gateway cluster).
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The ID of the security group.
securityGroupName string | @alicloud/ros-cdk-core.IResolvable Property securityGroupName: The name of the security group to create.
sshEnable boolean | @alicloud/ros-cdk-core.IResolvable Property sshEnable: Indicates whether SSH is enabled.
tags TagsProperty[] Property tags: Tags to attach to instance.
useCustomHiveMetaDb boolean | @alicloud/ros-cdk-core.IResolvable Property useCustomHiveMetaDb: A reserved parameter.
userDefinedEmrEcsRole string | @alicloud/ros-cdk-core.IResolvable Property userDefinedEmrEcsRole: The role that is assigned to EMR for calling ECS resources.
userInfo @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | UserInfoProperty[] Property userInfo:.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the Vswitch.
whiteListType string | @alicloud/ros-cdk-core.IResolvable Property whiteListType: Not required.

chargeTypeRequired 

public readonly chargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: The billing method.

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

clusterTypeRequired 

public readonly clusterType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property clusterType: The type of the cluster.

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

emrVerRequired 

public readonly emrVer: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property emrVer: The version of EMR.

hostGroupRequired 

public readonly hostGroup: IResolvable | IResolvable | HostGroupProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | HostGroupProperty[]

Property hostGroup:.

nameRequired 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/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 (_).

netTypeRequired 

public readonly netType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property netType: The type of the network.

useLocalMetaDbRequired 

public readonly useLocalMetaDb: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

zoneIdRequired 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone ID.

authorizeContentOptional 

public readonly authorizeContent: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property authorizeContent: Not required.

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

bootstrapActionOptional 

public readonly bootstrapAction: IResolvable | IResolvable | BootstrapActionProperty[];

Property bootstrapAction:.

clickHouseConfOptional 

public readonly clickHouseConf: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property clickHouseConf: undefined.

configOptional 

public readonly config: IResolvable | IResolvable | ConfigProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ConfigProperty[]

Property config:.

configurationsOptional 

public readonly configurations: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property configurations: Not required.

depositTypeOptional 

public readonly depositType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property depositType: The hosting type.

easEnableOptional 

public readonly easEnable: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

highAvailabilityEnableOptional 

public readonly highAvailabilityEnable: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

initCustomHiveMetaDbOptional 

public readonly initCustomHiveMetaDb: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property initCustomHiveMetaDb: A reserved parameter.

Not required.

instanceGenerationOptional 

public readonly instanceGeneration: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceGeneration: The generation of the ECS instances.

ioOptimizedOptional 

public readonly ioOptimized: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

Default value: true.

isOpenPublicIpOptional 

public readonly isOpenPublicIp: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

keyPairNameOptional 

public readonly keyPairName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property keyPairName: The name of the key pair.

logPathOptional 

public readonly logPath: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property logPath: The log path in OSS.

machineTypeOptional 

public readonly machineType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property machineType: The type of the machine.

masterPwdOptional 

public readonly masterPwd: string | IResolvable;
  • Type: string | @alicloud/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).

metaStoreConfOptional 

public readonly metaStoreConf: string | IResolvable;
  • Type: string | @alicloud/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"}

metaStoreTypeOptional 

public readonly metaStoreType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property metaStoreType: Meta store type.

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

optionSoftWareListOptional 

public readonly optionSoftWareList: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property optionSoftWareList: The list of optional services.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/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.

relatedClusterIdOptional 

public readonly relatedClusterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

securityGroupIdOptional 

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/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.

securityGroupNameOptional 

public readonly securityGroupName: string | IResolvable;
  • Type: string | @alicloud/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.

sshEnableOptional 

public readonly sshEnable: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property sshEnable: Indicates whether SSH is enabled.

tagsOptional 

public readonly tags: TagsProperty[];

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.

useCustomHiveMetaDbOptional 

public readonly useCustomHiveMetaDb: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property useCustomHiveMetaDb: A reserved parameter.

Not required.

userDefinedEmrEcsRoleOptional 

public readonly userDefinedEmrEcsRole: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

userInfoOptional 

public readonly userInfo: IResolvable | IResolvable | UserInfoProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | UserInfoProperty[]

Property userInfo:.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the VPC.

A value is required when NetType=vpc.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the Vswitch.

A value is required when NetType=vpc.

whiteListTypeOptional 

public readonly whiteListType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property whiteListType: Not required.