software.amazon.awssdk.services.emr.model

Class RunJobFlowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.emr.model.EmrRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>

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

Input to the RunJobFlow operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RunJobFlowRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	additionalInfo() A JSON string for selecting additional features.
String	amiVersion() Applies only to Amazon EMR AMI versions 3.x and 2.x.
List<Application>	applications() Applies to Amazon EMR releases 4.0 and later.
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() For Amazon EMR releases 4.0 and later.
String	customAmiId() Available only in Amazon EMR version 5.7.0 and later.
Integer	ebsRootVolumeSize() The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
JobFlowInstancesConfig	instances() A specification of the number and type of Amazon EC2 instances.
String	jobFlowRole() Also called instance profile and EC2 role.
KerberosAttributes	kerberosAttributes() Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
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() The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
RepoUpgradeOnBoot	repoUpgradeOnBoot() Applies only when CustomAmiID is used.
String	repoUpgradeOnBootAsString() Applies only when CustomAmiID is used.
ScaleDownBehavior	scaleDownBehavior() Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
String	scaleDownBehaviorAsString() Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
List<SdkField<?>>	sdkFields()
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()
String	toString() Returns a string representation of this object.
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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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()

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.

Returns:

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.

releaseLabel

public String releaseLabel()

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, for example, emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see http://docs.aws.amazon.com /emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use AmiVersion.

Returns:

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, for example, emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see http://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use AmiVersion.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

newSupportedProducts

public List<SupportedProductConfig> newSupportedProducts()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 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()

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 EMR Release Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 EMR Release Guide.

configurations

public List<Configuration> configurations()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

For Amazon EMR releases 4.0 and 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

If the service returns an enum value that is not available in the current SDK version, scaleDownBehavior will return ScaleDownBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scaleDownBehaviorAsString().

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

scaleDownBehaviorAsString

public String scaleDownBehaviorAsString()

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.

If the service returns an enum value that is not available in the current SDK version, scaleDownBehavior will return ScaleDownBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scaleDownBehaviorAsString().

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

customAmiId

public String customAmiId()

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.

Returns:

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.

ebsRootVolumeSize

public Integer ebsRootVolumeSize()

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

Returns:

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

repoUpgradeOnBoot

public RepoUpgradeOnBoot repoUpgradeOnBoot()

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.

If the service returns an enum value that is not available in the current SDK version, repoUpgradeOnBoot will return RepoUpgradeOnBoot.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from repoUpgradeOnBootAsString().

Returns:

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.

See Also:

RepoUpgradeOnBoot

repoUpgradeOnBootAsString

public String repoUpgradeOnBootAsString()

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.

If the service returns an enum value that is not available in the current SDK version, repoUpgradeOnBoot will return RepoUpgradeOnBoot.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from repoUpgradeOnBootAsString().

Returns:

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.

See Also:

RepoUpgradeOnBoot

kerberosAttributes

public KerberosAttributes kerberosAttributes()

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

Returns:

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

toBuilder

public RunJobFlowRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>

Specified by:

toBuilder in class EmrRequest

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()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo