Cloud.Service.AWS.EMR.Cluster

Cloud.Service.AWS.EMR.Cluster
Cloud.Service.AWS.EMR.Cluster
JSON Example
{
    "account": "string",
    "additional_info": "string",
    "applications": [
        "string"
    ],
    "autoscaling_role": "string",
    "bootstrap_action": [
        {
            "args": [
                "string"
            ],
            "name": "string",
            "path": "string"
        }
    ],
    "cluster_state": "string",
    "configurations": "string",
    "configurations_json": "string",
    "core_instance_count": 0,
    "core_instance_type": "string",
    "count": 0,
    "custom_ami_id": "string",
    "ebs_root_volume_size": 0,
    "ec2_attributes": [
        {
            "additional_master_security_groups": "string",
            "additional_slave_security_groups": "string",
            "emr_managed_master_security_group": "string",
            "emr_managed_slave_security_group": "string",
            "instance_profile": "string",
            "key_name": "string",
            "service_access_security_group": "string",
            "subnet_id": "string"
        }
    ],
    "instance_group": [
        {
            "autoscaling_policy": "string",
            "bid_price": "string",
            "ebs_config": [
                {
                    "iops": 0,
                    "size": 0,
                    "type": "string",
                    "volumes_per_instance": 0
                }
            ],
            "id": "string",
            "instance_count": 0,
            "instance_role": "string",
            "instance_type": "string",
            "name": "string"
        }
    ],
    "keep_job_flow_alive_when_no_steps": false,
    "kerberos_attributes": [
        {
            "ad_domain_join_password": "string",
            "ad_domain_join_user": "string",
            "cross_realm_trust_principal_password": "string",
            "kdc_admin_password": "string",
            "realm": "string"
        }
    ],
    "log_uri": "string",
    "master_instance_type": "string",
    "master_public_dns": "string",
    "name": "string",
    "region": "string",
    "release_label": "string",
    "scale_down_behavior": "string",
    "security_configuration": "string",
    "service_role": "string",
    "step": [
        {
            "action_on_failure": "string",
            "hadoop_jar_step": [
                {
                    "args": [
                        "string"
                    ],
                    "jar": "string",
                    "main_class": "string",
                    "properties": {}
                }
            ],
            "name": "string"
        }
    ],
    "tags": {},
    "termination_protection": false,
    "visible_to_all_users": false
}
string
account
Required

(Required) The name of the AWS cloud account to use for this resource

string
additional_info
Optional

JSON string for additional features, such as proxy information. There is no API to retrieve this argument value from the provider after EMR cluster creation, so the application cannot detect drift from the actual EMR cluster if its value is changed outside it.

array of string
applications
Optional

Applications to add to the cluster: Flink, Hadoop, Hive, Mahout, Pig, Spark, and JupyterHub. Multiples allowed. Case insensitive as of EMR 5.14.0.

string
autoscaling_role
Optional

IAM role that provides permissions that automatic scaling requires in order to launch and terminate EC2 instances in an instance group.

array of object
bootstrap_action
Optional

Settings for bootstrap actions to run before Hadoop is started.

string
cluster_state
Optional

State of the EMR cluster: STARTING, BOOTSTRAPPING, RUNNING, WAITING, TERMINATING, TERMINATED, or TERMINATED_WITH_ERRORS.

string
configurations
Optional

JSON file used for overriding default configurations for applications. See the AWS EMR documentation about configuring applications.

string
configurations_json
Optional

JSON string for supplying a list of configurations for the EMR cluster.

integer
core_instance_count
Optional

Total number of Amazon EC2 instances used to execute the job flow. Default is 1. EMR uses one of these nodes as the cluster master node and the remainder as core nodes. Cannot be specified if instance_groups is set.

string
core_instance_type
Optional

The EC2 instance type of the slave nodes. Cannot be specified if instance_groups is set.

integer
count
Optional

The number of resource instances to be created.

string
custom_ami_id
Optional

In EMR 5.7.0 and later, a custom Amazon Linux AMI for the cluster, instead of an EMR-owned AMI.

integer
ebs_root_volume_size
Optional

In EMR 4.x and later, size in gigabytes of the EBS root device volume of the Linux AMI used for each EC2 instance.

array of object
ec2_attributes
Optional

Attribute settings for the EC2 instances that are running the job.

array of object
instance_group
Optional

A list of instance_group objects for each instance group in the cluster. Exactly one master_instance_type and instance_group must be specified. When instance_group is set, it must contain a configuration block for at least the MASTER instance group type, plus any additional instance groups.

boolean
keep_job_flow_alive_when_no_steps
Optional

Whether to keep the cluster running when no steps are underway or all steps are complete. Default is on.

array of object
kerberos_attributes
Optional

Settings for Kerberos configuration of the cluster.

string
log_uri
Optional

Simple storage service (S3) bucket in which to store job log files.

string
master_instance_type
Optional

The EC2 instance type of the master node. Exactly one master_instance_type and instance_group must be specified.

string
master_public_dns
Optional

Public DNS name of the master node EC2 instance.

string
name
Required

(Required) The name of the entire job flow.

string
region
Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

string
release_label
Required

(Required) Name of the Amazon EMR version.

string
scale_down_behavior
Optional

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

string
security_configuration
Optional

The security configuration name to attach to the EMR cluster. Only valid for EMR clusters with release_label of 4.8.0 or later.

string
service_role
Required

(Required) Identity and Access Management (IAM) role that the Amazon EMR service assumes to access AWS resources.

array of object
step
Optional

All steps to run when creating the Elastic Map Reduce (EMR) cluster. Use life cycle configuration block with ignore_changes if other steps are being managed outside of the application.

object
tags
Optional

List of tags to apply to the EMR cluster.

boolean
termination_protection
Optional

Whether to protect the instance from automatic termination. Default is off.

boolean
visible_to_all_users
Optional

Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. Default is true.