Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RunJobFlowCommandInput

Hierarchy

Index

Properties

Optional AdditionalInfo

AdditionalInfo: undefined | string

A JSON string for selecting additional features.

Optional AmiVersion

AmiVersion: undefined | string

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Optional Applications

Applications: Application[]

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.

Optional AutoScalingRole

AutoScalingRole: undefined | string

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Optional AutoTerminationPolicy

AutoTerminationPolicy: AutoTerminationPolicy

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

Optional BootstrapActions

BootstrapActions: BootstrapActionConfig[]

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

Optional Configurations

Configurations: Configuration[]

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

Optional CustomAmiId

CustomAmiId: undefined | string

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

Optional EbsRootVolumeSize

EbsRootVolumeSize: undefined | number

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Instances

Instances: JobFlowInstancesConfig | undefined

A specification of the number and type of Amazon EC2 instances.

Optional JobFlowRole

JobFlowRole: undefined | string

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

Optional KerberosAttributes

KerberosAttributes: KerberosAttributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Optional LogEncryptionKmsKeyId

LogEncryptionKmsKeyId: undefined | string

The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.

Optional LogUri

LogUri: undefined | string

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

Optional ManagedScalingPolicy

ManagedScalingPolicy: ManagedScalingPolicy

The specified managed scaling policy for an Amazon EMR cluster.

Name

Name: string | undefined

The name of the job flow.

Optional NewSupportedProducts

NewSupportedProducts: SupportedProductConfig[]

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are:

  • "mapr-m3" - launch the cluster using MapR M3 Edition.

  • "mapr-m5" - launch the cluster using MapR M5 Edition.

  • "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.

  • "mapr-m7" - launch the cluster using MapR M7 Edition.

  • "hunk" - launch the cluster with the Hunk Big Data Analytics Platform.

  • "hue"- launch the cluster with Hue installed.

  • "spark" - launch the cluster with Apache Spark installed.

  • "ganglia" - launch the cluster with the Ganglia Monitoring System installed.

Optional OSReleaseLabel

OSReleaseLabel: undefined | string

Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.

Optional PlacementGroupConfigs

PlacementGroupConfigs: PlacementGroupConfig[]

The specified placement group configuration for an Amazon EMR cluster.

Optional ReleaseLabel

ReleaseLabel: undefined | string

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Optional RepoUpgradeOnBoot

RepoUpgradeOnBoot: RepoUpgradeOnBoot | string

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

Optional ScaleDownBehavior

ScaleDownBehavior: ScaleDownBehavior | string

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

Optional SecurityConfiguration

SecurityConfiguration: undefined | string

The name of a security configuration to apply to the cluster.

Optional ServiceRole

ServiceRole: undefined | string

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Optional StepConcurrencyLevel

StepConcurrencyLevel: undefined | number

Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

Optional Steps

Steps: StepConfig[]

A list of steps to run.

Optional SupportedProducts

SupportedProducts: string[]

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

  • "mapr-m3" - launch the job flow using MapR M3 Edition.

  • "mapr-m5" - launch the job flow using MapR M5 Edition.

Optional Tags

Tags: Tag[]

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

Optional VisibleToAllUsers

VisibleToAllUsers: undefined | false | true

The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.

Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.