CopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>, SdkBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>public static interface RunJobFlowRequest.Builder extends CopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
| Modifier and Type | Method | Description |
|---|---|---|
RunJobFlowRequest.Builder |
additionalInfo(String additionalInfo) |
A JSON string for selecting additional features.
|
RunJobFlowRequest.Builder |
amiVersion(String amiVersion) |
|
RunJobFlowRequest.Builder |
applications(Collection<Application> applications) |
|
RunJobFlowRequest.Builder |
applications(Application... applications) |
|
RunJobFlowRequest.Builder |
autoScalingRole(String autoScalingRole) |
An IAM role for automatic scaling policies.
|
RunJobFlowRequest.Builder |
bootstrapActions(Collection<BootstrapActionConfig> bootstrapActions) |
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
RunJobFlowRequest.Builder |
bootstrapActions(BootstrapActionConfig... bootstrapActions) |
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
RunJobFlowRequest.Builder |
configurations(Collection<Configuration> configurations) |
|
RunJobFlowRequest.Builder |
configurations(Configuration... configurations) |
|
RunJobFlowRequest.Builder |
instances(JobFlowInstancesConfig instances) |
A specification of the number and type of Amazon EC2 instances.
|
RunJobFlowRequest.Builder |
jobFlowRole(String jobFlowRole) |
Also called instance profile and EC2 role.
|
RunJobFlowRequest.Builder |
logUri(String logUri) |
The location in Amazon S3 to write the log files of the job flow.
|
RunJobFlowRequest.Builder |
name(String name) |
The name of the job flow.
|
RunJobFlowRequest.Builder |
newSupportedProducts(Collection<SupportedProductConfig> newSupportedProducts) |
|
RunJobFlowRequest.Builder |
newSupportedProducts(SupportedProductConfig... newSupportedProducts) |
|
RunJobFlowRequest.Builder |
releaseLabel(String releaseLabel) |
|
RunJobFlowRequest.Builder |
scaleDownBehavior(String scaleDownBehavior) |
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs
or an instance group is resized.
|
RunJobFlowRequest.Builder |
scaleDownBehavior(ScaleDownBehavior scaleDownBehavior) |
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs
or an instance group is resized.
|
RunJobFlowRequest.Builder |
securityConfiguration(String securityConfiguration) |
The name of a security configuration to apply to the cluster.
|
RunJobFlowRequest.Builder |
serviceRole(String serviceRole) |
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
|
RunJobFlowRequest.Builder |
steps(Collection<StepConfig> steps) |
A list of steps to run.
|
RunJobFlowRequest.Builder |
steps(StepConfig... steps) |
A list of steps to run.
|
RunJobFlowRequest.Builder |
supportedProducts(String... supportedProducts) |
|
RunJobFlowRequest.Builder |
supportedProducts(Collection<String> supportedProducts) |
|
RunJobFlowRequest.Builder |
tags(Collection<Tag> tags) |
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
|
RunJobFlowRequest.Builder |
tags(Tag... tags) |
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
|
RunJobFlowRequest.Builder |
visibleToAllUsers(Boolean visibleToAllUsers) |
Whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
|
copyapply, buildRunJobFlowRequest.Builder name(String name)
The name of the job flow.
name - The name of the job flow.RunJobFlowRequest.Builder logUri(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.
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.RunJobFlowRequest.Builder additionalInfo(String additionalInfo)
A JSON string for selecting additional features.
additionalInfo - A JSON string for selecting additional features.RunJobFlowRequest.Builder amiVersion(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).
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).
RunJobFlowRequest.Builder releaseLabel(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.
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.
RunJobFlowRequest.Builder instances(JobFlowInstancesConfig instances)
A specification of the number and type of Amazon EC2 instances.
instances - A specification of the number and type of Amazon EC2 instances.RunJobFlowRequest.Builder steps(Collection<StepConfig> steps)
A list of steps to run.
steps - A list of steps to run.RunJobFlowRequest.Builder steps(StepConfig... steps)
A list of steps to run.
NOTE: This method appends the values to the existing list (if any). Use
#setSteps(java.util.Collection) or #withSteps(java.util.Collection) if you want to override
the existing values.
steps - A list of steps to run.RunJobFlowRequest.Builder bootstrapActions(Collection<BootstrapActionConfig> bootstrapActions)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
bootstrapActions - A list of bootstrap actions to run before Hadoop starts on the cluster nodes.RunJobFlowRequest.Builder bootstrapActions(BootstrapActionConfig... bootstrapActions)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
NOTE: This method appends the values to the existing list (if any). Use
#setBootstrapActions(java.util.Collection) or #withBootstrapActions(java.util.Collection) if
you want to override the existing values.
bootstrapActions - A list of bootstrap actions to run before Hadoop starts on the cluster nodes.RunJobFlowRequest.Builder supportedProducts(Collection<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.
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.
RunJobFlowRequest.Builder supportedProducts(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.
NOTE: This method appends the values to the existing list (if any). Use
#setSupportedProducts(java.util.Collection) or #withSupportedProducts(java.util.Collection)
if you want to override the existing values.
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.
RunJobFlowRequest.Builder newSupportedProducts(Collection<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.
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.
RunJobFlowRequest.Builder newSupportedProducts(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.
NOTE: This method appends the values to the existing list (if any). Use
#setNewSupportedProducts(java.util.Collection) or
#withNewSupportedProducts(java.util.Collection) if you want to override the existing values.
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.
RunJobFlowRequest.Builder applications(Collection<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.
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.
RunJobFlowRequest.Builder applications(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.
NOTE: This method appends the values to the existing list (if any). Use
#setApplications(java.util.Collection) or #withApplications(java.util.Collection) if you want
to override the existing values.
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.
RunJobFlowRequest.Builder configurations(Collection<Configuration> configurations)
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
configurations - Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
RunJobFlowRequest.Builder configurations(Configuration... configurations)
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
NOTE: This method appends the values to the existing list (if any). Use
#setConfigurations(java.util.Collection) or #withConfigurations(java.util.Collection) if you
want to override the existing values.
configurations - Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
RunJobFlowRequest.Builder visibleToAllUsers(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.
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.RunJobFlowRequest.Builder jobFlowRole(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.
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.RunJobFlowRequest.Builder serviceRole(String serviceRole)
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
serviceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.RunJobFlowRequest.Builder tags(Collection<Tag> tags)
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
tags - A list of tags to associate with a cluster and propagate to Amazon EC2 instances.RunJobFlowRequest.Builder tags(Tag... tags)
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
NOTE: This method appends the values to the existing list (if any). Use
#setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the
existing values.
tags - A list of tags to associate with a cluster and propagate to Amazon EC2 instances.RunJobFlowRequest.Builder securityConfiguration(String securityConfiguration)
The name of a security configuration to apply to the cluster.
securityConfiguration - The name of a security configuration to apply to the cluster.RunJobFlowRequest.Builder autoScalingRole(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.
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.RunJobFlowRequest.Builder scaleDownBehavior(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.
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.ScaleDownBehaviorRunJobFlowRequest.Builder scaleDownBehavior(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.
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.ScaleDownBehaviorCopyright © 2017 Amazon Web Services, Inc. All Rights Reserved.