Skip to content

ClusterProps

Properties for defining a Cluster.

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

Initializer 

using AlibabaCloud.SDK.ROS.CDK.Emr;
new ClusterProps {
    object ChargeType,
    object ClusterType,
    object EmrVer,
    object HostGroup,
    object Name,
    object NetType,
    object UseLocalMetaDb,
    object ZoneId,
    object AuthorizeContent = null,
    object AutoRenew = null,
    object BootstrapAction = null,
    object ClickHouseConf = null,
    object Config = null,
    object Configurations = null,
    object DepositType = null,
    object EasEnable = null,
    object HighAvailabilityEnable = null,
    object InitCustomHiveMetaDb = null,
    object InstanceGeneration = null,
    object IoOptimized = null,
    object IsOpenPublicIp = null,
    object KeyPairName = null,
    object LogPath = null,
    object MachineType = null,
    object MasterPwd = null,
    object MetaStoreConf = null,
    object MetaStoreType = null,
    object OptionSoftWareList = null,
    object Period = null,
    object RelatedClusterId = null,
    object ResourceGroupId = null,
    object SecurityGroupId = null,
    object SecurityGroupName = null,
    object SshEnable = null,
    TagsProperty[] Tags = null,
    object UseCustomHiveMetaDb = null,
    object UserDefinedEmrEcsRole = null,
    object UserInfo = null,
    object VpcId = null,
    object VSwitchId = null,
    object WhiteListType = null
};

Properties

Name Type Description
ChargeType object Property chargeType: The billing method.
ClusterType object Property clusterType: The type of the cluster.
EmrVer object Property emrVer: The version of EMR.
HostGroup object Property hostGroup:.
Name object Property name: The name of the cluster.
NetType object Property netType: The type of the network.
UseLocalMetaDb object Property useLocalMetaDb: Indicates whether the local Hive metadatabase is used.
ZoneId object Property zoneId: The zone ID.
AuthorizeContent object Property authorizeContent: Not required.
AutoRenew object Property autoRenew: Indicates whether the subscription cluster is auto-renewed.
BootstrapAction object Property bootstrapAction:.
ClickHouseConf object Property clickHouseConf: undefined.
Config object Property config:.
Configurations object Property configurations: Not required.
DepositType object Property depositType: The hosting type.
EasEnable object Property easEnable: Indicates whether the cluster is a high-security cluster.
HighAvailabilityEnable object Property highAvailabilityEnable: Indicates whether the cluster is a high-availability cluster.
InitCustomHiveMetaDb object Property initCustomHiveMetaDb: A reserved parameter.
InstanceGeneration object Property instanceGeneration: The generation of the ECS instances.
IoOptimized object Property ioOptimized: Indicates wether I\/O optimization is enabled.
IsOpenPublicIp object Property isOpenPublicIp: Indicates whether a public IP address is assigned.
KeyPairName object Property keyPairName: The name of the key pair.
LogPath object Property logPath: The log path in OSS.
MachineType object Property machineType: The type of the machine.
MasterPwd object Property masterPwd: The SSH password for the master node.
MetaStoreConf object Property metaStoreConf: Meta store conf of specific meta store type.
MetaStoreType object Property metaStoreType: Meta store type.
OptionSoftWareList object Property optionSoftWareList: The list of optional services.
Period object Property period: The length of the subscription.
RelatedClusterId object Property relatedClusterId: The ID of the primary cluster (when the cluster that you create is a Gateway cluster).
ResourceGroupId object Property resourceGroupId: Resource group id.
SecurityGroupId object Property securityGroupId: The ID of the security group.
SecurityGroupName object Property securityGroupName: The name of the security group to create.
SshEnable object Property sshEnable: Indicates whether SSH is enabled.
Tags TagsProperty[] Property tags: Tags to attach to instance.
UseCustomHiveMetaDb object Property useCustomHiveMetaDb: A reserved parameter.
UserDefinedEmrEcsRole object Property userDefinedEmrEcsRole: The role that is assigned to EMR for calling ECS resources.
UserInfo object Property userInfo:.
VpcId object Property vpcId: The ID of the VPC.
VSwitchId object Property vSwitchId: The ID of the Vswitch.
WhiteListType object Property whiteListType: Not required.

ChargeTypeRequired 

public object ChargeType { get; set; }
  • Type: object

Property chargeType: The billing method.

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

ClusterTypeRequired 

public object ClusterType { get; set; }
  • Type: object

Property clusterType: The type of the cluster.

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

EmrVerRequired 

public object EmrVer { get; set; }
  • Type: object

Property emrVer: The version of EMR.

HostGroupRequired 

public object HostGroup { get; set; }
  • Type: object

Property hostGroup:.

NameRequired 

public object Name { get; set; }
  • Type: object

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 object NetType { get; set; }
  • Type: object

Property netType: The type of the network.

UseLocalMetaDbRequired 

public object UseLocalMetaDb { get; set; }
  • Type: object

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

ZoneIdRequired 

public object ZoneId { get; set; }
  • Type: object

Property zoneId: The zone ID.

AuthorizeContentOptional 

public object AuthorizeContent { get; set; }
  • Type: object

Property authorizeContent: Not required.

AutoRenewOptional 

public object AutoRenew { get; set; }
  • Type: object

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

BootstrapActionOptional 

public object BootstrapAction { get; set; }
  • Type: object

Property bootstrapAction:.

ClickHouseConfOptional 

public object ClickHouseConf { get; set; }
  • Type: object

Property clickHouseConf: undefined.

ConfigOptional 

public object Config { get; set; }
  • Type: object

Property config:.

ConfigurationsOptional 

public object Configurations { get; set; }
  • Type: object

Property configurations: Not required.

DepositTypeOptional 

public object DepositType { get; set; }
  • Type: object

Property depositType: The hosting type.

EasEnableOptional 

public object EasEnable { get; set; }
  • Type: object

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

HighAvailabilityEnableOptional 

public object HighAvailabilityEnable { get; set; }
  • Type: object

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

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

InitCustomHiveMetaDbOptional 

public object InitCustomHiveMetaDb { get; set; }
  • Type: object

Property initCustomHiveMetaDb: A reserved parameter.

Not required.

InstanceGenerationOptional 

public object InstanceGeneration { get; set; }
  • Type: object

Property instanceGeneration: The generation of the ECS instances.

IoOptimizedOptional 

public object IoOptimized { get; set; }
  • Type: object

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

Default value: true.

IsOpenPublicIpOptional 

public object IsOpenPublicIp { get; set; }
  • Type: object

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 object KeyPairName { get; set; }
  • Type: object

Property keyPairName: The name of the key pair.

LogPathOptional 

public object LogPath { get; set; }
  • Type: object

Property logPath: The log path in OSS.

MachineTypeOptional 

public object MachineType { get; set; }
  • Type: object

Property machineType: The type of the machine.

MasterPwdOptional 

public object MasterPwd { get; set; }
  • Type: object

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 object MetaStoreConf { get; set; }
  • Type: object

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 object MetaStoreType { get; set; }
  • Type: object

Property metaStoreType: Meta store type.

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

OptionSoftWareListOptional 

public object OptionSoftWareList { get; set; }
  • Type: object

Property optionSoftWareList: The list of optional services.

PeriodOptional 

public object Period { get; set; }
  • Type: object

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 object RelatedClusterId { get; set; }
  • Type: object

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

ResourceGroupIdOptional 

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: Resource group id.

SecurityGroupIdOptional 

public object SecurityGroupId { get; set; }
  • Type: object

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 object SecurityGroupName { get; set; }
  • Type: object

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 object SshEnable { get; set; }
  • Type: object

Property sshEnable: Indicates whether SSH is enabled.

TagsOptional 

public TagsProperty[] Tags { get; set; }

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 object UseCustomHiveMetaDb { get; set; }
  • Type: object

Property useCustomHiveMetaDb: A reserved parameter.

Not required.

UserDefinedEmrEcsRoleOptional 

public object UserDefinedEmrEcsRole { get; set; }
  • Type: object

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

UserInfoOptional 

public object UserInfo { get; set; }
  • Type: object

Property userInfo:.

VpcIdOptional 

public object VpcId { get; set; }
  • Type: object

Property vpcId: The ID of the VPC.

A value is required when NetType=vpc.

VSwitchIdOptional 

public object VSwitchId { get; set; }
  • Type: object

Property vSwitchId: The ID of the Vswitch.

A value is required when NetType=vpc.

WhiteListTypeOptional 

public object WhiteListType { get; set; }
  • Type: object

Property whiteListType: Not required.