Package software.amazon.awssdk.services.emr.model

Class RunJobFlowRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.emr.model.RunJobFlowRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>

@Generated("software.amazon.awssdk:codegen")
public class RunJobFlowRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>

Input to the RunJobFlow operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RunJobFlowRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	additionalInfo()	A JSON string for selecting additional features.
String	amiVersion()
List<Application>	applications()
String	autoScalingRole()	An IAM role for automatic scaling policies.
List<BootstrapActionConfig>	bootstrapActions()	A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
static RunJobFlowRequest.Builder	builder()
List<Configuration>	configurations()
boolean	equals(Object obj)
int	hashCode()
JobFlowInstancesConfig	instances()	A specification of the number and type of Amazon EC2 instances.
String	jobFlowRole()	Also called instance profile and EC2 role.
String	logUri()	The location in Amazon S3 to write the log files of the job flow.
String	name()	The name of the job flow.
List<SupportedProductConfig>	newSupportedProducts()
String	releaseLabel()
String	scaleDownBehavior()	Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
String	securityConfiguration()	The name of a security configuration to apply to the cluster.
static Class<? extends RunJobFlowRequest.Builder>	serializableBuilderClass()
String	serviceRole()	The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
List<StepConfig>	steps()	A list of steps to run.
List<String>	supportedProducts()
List<Tag>	tags()	A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
RunJobFlowRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	visibleToAllUsers()	Whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

The name of the job flow.

Returns:

The name of the job flow.

logUri

public String logUri()

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

Returns:

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

additionalInfo

public String additionalInfo()

A JSON string for selecting additional features.

Returns:

A JSON string for selecting additional features.

amiVersion

public String amiVersion()

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

• The version number of the AMI to use, for example, "2.0."

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.

For details about the AMI versions currently supported by Amazon Elastic MapReduce, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).

Returns:

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

• The version number of the AMI to use, for example, "2.0."

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.

For details about the AMI versions currently supported by Amazon Elastic MapReduce, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).

releaseLabel

public String releaseLabel()

Amazon EMR releases 4.x or later.

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

Returns:

Amazon EMR releases 4.x or later.

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

instances

public JobFlowInstancesConfig instances()

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

Returns:

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

steps

public List<StepConfig> steps()

A list of steps to run.

Returns:

A list of steps to run.

bootstrapActions

public List<BootstrapActionConfig> bootstrapActions()

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

Returns:

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

supportedProducts

public List<String> supportedProducts()

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

A list of strings that indicates third-party software to use. For more information, see Use Third Party Applications with Amazon EMR. Currently supported values are:

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

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

Returns:

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

A list of strings that indicates third-party software to use. For more information, see Use Third Party Applications with Amazon EMR. Currently supported values are:

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

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

newSupportedProducts

public List<SupportedProductConfig> newSupportedProducts()

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, 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 Analtics 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.

Returns:

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, 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 Analtics 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.

applications

public List<Application> applications()

Amazon EMR releases 4.x or later.

A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.

Returns:

Amazon EMR releases 4.x or later.

A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.

configurations

public List<Configuration> configurations()

Amazon EMR releases 4.x or later.

The list of configurations supplied for the EMR cluster you are creating.

Returns:

Amazon EMR releases 4.x or later.

The list of configurations supplied for the EMR cluster you are creating.

visibleToAllUsers

public Boolean visibleToAllUsers()

Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it.

Returns:

Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it.

jobFlowRole

public String jobFlowRole()

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.

Returns:

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.

serviceRole

public String serviceRole()

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Returns:

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

tags

public List<Tag> tags()

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

Returns:

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

securityConfiguration

public String securityConfiguration()

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

Returns:

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

autoScalingRole

public String autoScalingRole()

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.

Returns:

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.

scaleDownBehavior

public String scaleDownBehavior()

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 blacklists 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.

Returns:

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 blacklists 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.

See Also:

ScaleDownBehavior

toBuilder

public RunJobFlowRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>

Returns:

a builder for type T

builder

public static RunJobFlowRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RunJobFlowRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object