Cluster

Provides a EMR Cluster resource. With this you can create, read, and release EMR Cluster.

NOTE: Available in 1.57.0+.

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

def Cluster(resource_name, opts=None, bootstrap_actions=None, charge_type=None, cluster_type=None, deposit_type=None, eas_enable=None, emr_ver=None, high_availability_enable=None, host_groups=None, is_open_public_ip=None, key_pair_name=None, master_pwd=None, name=None, option_software_lists=None, related_cluster_id=None, security_group_id=None, ssh_enable=None, tags=None, use_local_metadb=None, user_defined_emr_ecs_role=None, vswitch_id=None, zone_id=None, __props__=None);

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Cluster resource accepts the following input properties:

ClusterType string: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
EmrVer string: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
ZoneId string: Zone ID, e.g. cn-huhehaote-a
BootstrapActions List<Pulumi.AliCloud.Emr.Inputs.ClusterBootstrapActionArgs>
ChargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
DepositType string: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
EasEnable bool: High security cluster (true) or not. Default value is false.
HighAvailabilityEnable bool: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
HostGroups List<Pulumi.AliCloud.Emr.Inputs.ClusterHostGroupArgs>: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
IsOpenPublicIp bool
KeyPairName string: Ssh key pair.
MasterPwd string: Master ssh password.
Name string: bootstrap action name.
OptionSoftwareLists List<string>: Optional software list.
RelatedClusterId string: This specify the related cluster id, if this cluster is a Gateway.
SecurityGroupId string: Security Group ID for Cluster, you can also specify this key for each host group.
SshEnable bool: If this is set true, we can ssh into cluster. Default value is false.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.
UseLocalMetadb bool: Use local metadb. Default is false.
UserDefinedEmrEcsRole string: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
VswitchId string: Global vswitch id, you can also specify it in host group.

ClusterType string: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
EmrVer string: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
ZoneId string: Zone ID, e.g. cn-huhehaote-a
BootstrapActions []ClusterBootstrapAction
ChargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
DepositType string: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
EasEnable bool: High security cluster (true) or not. Default value is false.
HighAvailabilityEnable bool: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
HostGroups []ClusterHostGroup: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
IsOpenPublicIp bool
KeyPairName string: Ssh key pair.
MasterPwd string: Master ssh password.
Name string: bootstrap action name.
OptionSoftwareLists []string: Optional software list.
RelatedClusterId string: This specify the related cluster id, if this cluster is a Gateway.
SecurityGroupId string: Security Group ID for Cluster, you can also specify this key for each host group.
SshEnable bool: If this is set true, we can ssh into cluster. Default value is false.
Tags map[string]interface{}: A mapping of tags to assign to the resource.
UseLocalMetadb bool: Use local metadb. Default is false.
UserDefinedEmrEcsRole string: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
VswitchId string: Global vswitch id, you can also specify it in host group.

clusterType string: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
emrVer string: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
zoneId string: Zone ID, e.g. cn-huhehaote-a
bootstrapActions ClusterBootstrapAction[]
chargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
depositType string: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
easEnable boolean: High security cluster (true) or not. Default value is false.
highAvailabilityEnable boolean: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
hostGroups ClusterHostGroup[]: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
isOpenPublicIp boolean
keyPairName string: Ssh key pair.
masterPwd string: Master ssh password.
name string: bootstrap action name.
optionSoftwareLists string[]: Optional software list.
relatedClusterId string: This specify the related cluster id, if this cluster is a Gateway.
securityGroupId string: Security Group ID for Cluster, you can also specify this key for each host group.
sshEnable boolean: If this is set true, we can ssh into cluster. Default value is false.
tags {[key: string]: any}: A mapping of tags to assign to the resource.
useLocalMetadb boolean: Use local metadb. Default is false.
userDefinedEmrEcsRole string: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
vswitchId string: Global vswitch id, you can also specify it in host group.

cluster_type str: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
emr_ver str: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
zone_id str: Zone ID, e.g. cn-huhehaote-a
bootstrap_actions List[ClusterBootstrapAction]
charge_type str: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
deposit_type str: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
eas_enable bool: High security cluster (true) or not. Default value is false.
high_availability_enable bool: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
host_groups List[ClusterHostGroup]: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
is_open_public_ip bool
key_pair_name str: Ssh key pair.
master_pwd str: Master ssh password.
name str: bootstrap action name.
option_software_lists List[str]: Optional software list.
related_cluster_id str: This specify the related cluster id, if this cluster is a Gateway.
security_group_id str: Security Group ID for Cluster, you can also specify this key for each host group.
ssh_enable bool: If this is set true, we can ssh into cluster. Default value is false.
tags Dict[str, Any]: A mapping of tags to assign to the resource.
use_local_metadb bool: Use local metadb. Default is false.
user_defined_emr_ecs_role str: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
vswitch_id str: Global vswitch id, you can also specify it in host group.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster

static get(resource_name, id, opts=None, bootstrap_actions=None, charge_type=None, cluster_type=None, deposit_type=None, eas_enable=None, emr_ver=None, high_availability_enable=None, host_groups=None, is_open_public_ip=None, key_pair_name=None, master_pwd=None, name=None, option_software_lists=None, related_cluster_id=None, security_group_id=None, ssh_enable=None, tags=None, use_local_metadb=None, user_defined_emr_ecs_role=None, vswitch_id=None, zone_id=None, __props__=None);

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BootstrapActions List<Pulumi.AliCloud.Emr.Inputs.ClusterBootstrapActionArgs>
ChargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
ClusterType string: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
DepositType string: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
EasEnable bool: High security cluster (true) or not. Default value is false.
EmrVer string: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
HighAvailabilityEnable bool: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
HostGroups List<Pulumi.AliCloud.Emr.Inputs.ClusterHostGroupArgs>: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
IsOpenPublicIp bool
KeyPairName string: Ssh key pair.
MasterPwd string: Master ssh password.
Name string: bootstrap action name.
OptionSoftwareLists List<string>: Optional software list.
RelatedClusterId string: This specify the related cluster id, if this cluster is a Gateway.
SecurityGroupId string: Security Group ID for Cluster, you can also specify this key for each host group.
SshEnable bool: If this is set true, we can ssh into cluster. Default value is false.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.
UseLocalMetadb bool: Use local metadb. Default is false.
UserDefinedEmrEcsRole string: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
VswitchId string: Global vswitch id, you can also specify it in host group.
ZoneId string: Zone ID, e.g. cn-huhehaote-a

BootstrapActions []ClusterBootstrapAction
ChargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
ClusterType string: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
DepositType string: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
EasEnable bool: High security cluster (true) or not. Default value is false.
EmrVer string: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
HighAvailabilityEnable bool: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
HostGroups []ClusterHostGroup: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
IsOpenPublicIp bool
KeyPairName string: Ssh key pair.
MasterPwd string: Master ssh password.
Name string: bootstrap action name.
OptionSoftwareLists []string: Optional software list.
RelatedClusterId string: This specify the related cluster id, if this cluster is a Gateway.
SecurityGroupId string: Security Group ID for Cluster, you can also specify this key for each host group.
SshEnable bool: If this is set true, we can ssh into cluster. Default value is false.
Tags map[string]interface{}: A mapping of tags to assign to the resource.
UseLocalMetadb bool: Use local metadb. Default is false.
UserDefinedEmrEcsRole string: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
VswitchId string: Global vswitch id, you can also specify it in host group.
ZoneId string: Zone ID, e.g. cn-huhehaote-a

bootstrapActions ClusterBootstrapAction[]
chargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
clusterType string: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
depositType string: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
easEnable boolean: High security cluster (true) or not. Default value is false.
emrVer string: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
highAvailabilityEnable boolean: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
hostGroups ClusterHostGroup[]: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
isOpenPublicIp boolean
keyPairName string: Ssh key pair.
masterPwd string: Master ssh password.
name string: bootstrap action name.
optionSoftwareLists string[]: Optional software list.
relatedClusterId string: This specify the related cluster id, if this cluster is a Gateway.
securityGroupId string: Security Group ID for Cluster, you can also specify this key for each host group.
sshEnable boolean: If this is set true, we can ssh into cluster. Default value is false.
tags {[key: string]: any}: A mapping of tags to assign to the resource.
useLocalMetadb boolean: Use local metadb. Default is false.
userDefinedEmrEcsRole string: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
vswitchId string: Global vswitch id, you can also specify it in host group.
zoneId string: Zone ID, e.g. cn-huhehaote-a

bootstrap_actions List[ClusterBootstrapAction]
charge_type str: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
cluster_type str: EMR Cluster Type, e.g. HADOOP, KAFKA, DRUID, GATEWAY etc. You can find all valid EMR cluster type in emr web console. Supported ‘GATEWAY’ available in 1.61.0+.
deposit_type str: Cluster deposit type, HALF_MANAGED or FULL_MANAGED.
eas_enable bool: High security cluster (true) or not. Default value is false.
emr_ver str: EMR Version, e.g. EMR-3.22.0. You can find the all valid EMR Version in emr web console.
high_availability_enable bool: High Available for HDFS and YARN. If this is set true, MASTER group must have two nodes.
host_groups List[ClusterHostGroup]: Groups of Host, You can specify MASTER as a group, CORE as a group (just like the above example).
is_open_public_ip bool
key_pair_name str: Ssh key pair.
master_pwd str: Master ssh password.
name str: bootstrap action name.
option_software_lists List[str]: Optional software list.
related_cluster_id str: This specify the related cluster id, if this cluster is a Gateway.
security_group_id str: Security Group ID for Cluster, you can also specify this key for each host group.
ssh_enable bool: If this is set true, we can ssh into cluster. Default value is false.
tags Dict[str, Any]: A mapping of tags to assign to the resource.
use_local_metadb bool: Use local metadb. Default is false.
user_defined_emr_ecs_role str: Alicloud EMR uses roles to perform actions on your behalf when provisioning cluster resources, running applications, dynamically scaling resources. EMR uses the following roles when interacting with other Alicloud services. Default value is AliyunEmrEcsDefaultRole.
vswitch_id str: Global vswitch id, you can also specify it in host group.
zone_id str: Zone ID, e.g. cn-huhehaote-a

Supporting Types

ClusterBootstrapAction

See the input and output API doc for this type.

Arg string: bootstrap action args, e.g. “–a=b”.
Name string: bootstrap action name.
Path string: bootstrap action path, e.g. “oss://bucket/path”.

Arg string: bootstrap action args, e.g. “–a=b”.
Name string: bootstrap action name.
Path string: bootstrap action path, e.g. “oss://bucket/path”.

arg string: bootstrap action args, e.g. “–a=b”.
name string: bootstrap action name.
path string: bootstrap action path, e.g. “oss://bucket/path”.

arg str: bootstrap action args, e.g. “–a=b”.
name str: bootstrap action name.
path str: bootstrap action path, e.g. “oss://bucket/path”.

ClusterHostGroup

See the input and output API doc for this type.

AutoRenew bool: Auto renew for prepaid, true of false. Default is false.
ChargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
DiskCapacity string: Data disk capacity.
DiskCount string: Data disk count.
DiskType string: Data disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,local_disk,cloud_essd.
GpuDriver string
HostGroupName string: host group name.
HostGroupType string: host group type, supported value: MASTER, CORE or TASK, supported ‘GATEWAY’ available in 1.61.0+.
InstanceList string: Instance list for cluster scale down. This value follows the json format, e.g. [“instance_id1”,“instance_id2”]. escape character for “ is \“.
InstanceType string: Host Ecs instance type.
NodeCount string: Host number in this group.
Period int: If charge type is PrePaid, this should be specified, unit is month. Supported value: 1、2、3、4、5、6、7、8、9、12、24、36.
SysDiskCapacity string: System disk capacity.
SysDiskType string: System disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,cloud_essd.

AutoRenew bool: Auto renew for prepaid, true of false. Default is false.
ChargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
DiskCapacity string: Data disk capacity.
DiskCount string: Data disk count.
DiskType string: Data disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,local_disk,cloud_essd.
GpuDriver string
HostGroupName string: host group name.
HostGroupType string: host group type, supported value: MASTER, CORE or TASK, supported ‘GATEWAY’ available in 1.61.0+.
InstanceList string: Instance list for cluster scale down. This value follows the json format, e.g. [“instance_id1”,“instance_id2”]. escape character for “ is \“.
InstanceType string: Host Ecs instance type.
NodeCount string: Host number in this group.
Period int: If charge type is PrePaid, this should be specified, unit is month. Supported value: 1、2、3、4、5、6、7、8、9、12、24、36.
SysDiskCapacity string: System disk capacity.
SysDiskType string: System disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,cloud_essd.

autoRenew boolean: Auto renew for prepaid, true of false. Default is false.
chargeType string: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
diskCapacity string: Data disk capacity.
diskCount string: Data disk count.
diskType string: Data disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,local_disk,cloud_essd.
gpuDriver string
hostGroupName string: host group name.
hostGroupType string: host group type, supported value: MASTER, CORE or TASK, supported ‘GATEWAY’ available in 1.61.0+.
instanceList string: Instance list for cluster scale down. This value follows the json format, e.g. [“instance_id1”,“instance_id2”]. escape character for “ is \“.
instanceType string: Host Ecs instance type.
nodeCount string: Host number in this group.
period number: If charge type is PrePaid, this should be specified, unit is month. Supported value: 1、2、3、4、5、6、7、8、9、12、24、36.
sysDiskCapacity string: System disk capacity.
sysDiskType string: System disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,cloud_essd.

auto_renew bool: Auto renew for prepaid, true of false. Default is false.
charge_type str: Charge Type for this group of hosts: PostPaid or PrePaid. If this is not specified, charge type will follow global charge_type value.
diskCapacity str: Data disk capacity.
diskCount str: Data disk count.
disk_type str: Data disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,local_disk,cloud_essd.
gpuDriver str
hostGroupName str: host group name.
hostGroupType str: host group type, supported value: MASTER, CORE or TASK, supported ‘GATEWAY’ available in 1.61.0+.
instanceList str: Instance list for cluster scale down. This value follows the json format, e.g. [“instance_id1”,“instance_id2”]. escape character for “ is \“.
instance_type str: Host Ecs instance type.
node_count str: Host number in this group.
period float: If charge type is PrePaid, this should be specified, unit is month. Supported value: 1、2、3、4、5、6、7、8、9、12、24、36.
sysDiskCapacity str: System disk capacity.
sysDiskType str: System disk type. Supported value: cloud,cloud_efficiency,cloud_ssd,cloud_essd.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud