public class RunJobFlowRequest extends AmazonWebServiceRequest implements Serializable
RunJobFlow operation
.
RunJobFlow creates and starts running a new job flow. The job flow
will run the steps specified. Once the job flow completes, the cluster
is stopped and the HDFS partition is lost. To prevent loss of data,
configure the last step of the job flow to store results in Amazon S3.
If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE
, the job flow will transition
to the WAITING state rather than shutting down once the steps have
completed.
For additional protection, you can set the JobFlowInstancesConfig
TerminationProtected
parameter to TRUE
to
lock the job flow and prevent it from being terminated by API call,
user intervention, or in the event of a job flow error.
A maximum of 256 steps are allowed in each job flow.
If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide .
For long running job flows, we recommend that you periodically store your results.
NOOP
Constructor and Description |
---|
RunJobFlowRequest()
Default constructor for a new RunJobFlowRequest object.
|
RunJobFlowRequest(String name,
JobFlowInstancesConfig instances)
Constructs a new RunJobFlowRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getAdditionalInfo()
A JSON string for selecting additional features.
|
String |
getAmiVersion()
The version of the Amazon Machine Image (AMI) to use when launching
Amazon EC2 instances in the job flow.
|
List<BootstrapActionConfig> |
getBootstrapActions()
A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.
|
JobFlowInstancesConfig |
getInstances()
A specification of the number and type of Amazon EC2 instances on
which to run the job flow.
|
String |
getJobFlowRole()
An IAM role for the job flow.
|
String |
getLogUri()
The location in Amazon S3 to write the log files of the job flow.
|
String |
getName()
The name of the job flow.
|
List<SupportedProductConfig> |
getNewSupportedProducts()
A list of strings that indicates third-party software to use with the
job flow that accepts a user argument list.
|
String |
getServiceRole()
The IAM role that will be assumed by the Amazon EMR service to access
AWS resources on your behalf.
|
List<StepConfig> |
getSteps()
A list of steps to be executed by the job flow.
|
List<String> |
getSupportedProducts()
A list of strings that indicates third-party software to use with the
job flow.
|
List<Tag> |
getTags()
A list of tags to associate with a cluster and propagate to Amazon EC2
instances.
|
Boolean |
getVisibleToAllUsers()
Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow.
|
int |
hashCode() |
Boolean |
isVisibleToAllUsers()
Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow.
|
void |
setAdditionalInfo(String additionalInfo)
A JSON string for selecting additional features.
|
void |
setAmiVersion(String amiVersion)
The version of the Amazon Machine Image (AMI) to use when launching
Amazon EC2 instances in the job flow.
|
void |
setBootstrapActions(Collection<BootstrapActionConfig> bootstrapActions)
A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.
|
void |
setInstances(JobFlowInstancesConfig instances)
A specification of the number and type of Amazon EC2 instances on
which to run the job flow.
|
void |
setJobFlowRole(String jobFlowRole)
An IAM role for the job flow.
|
void |
setLogUri(String logUri)
The location in Amazon S3 to write the log files of the job flow.
|
void |
setName(String name)
The name of the job flow.
|
void |
setNewSupportedProducts(Collection<SupportedProductConfig> newSupportedProducts)
A list of strings that indicates third-party software to use with the
job flow that accepts a user argument list.
|
void |
setServiceRole(String serviceRole)
The IAM role that will be assumed by the Amazon EMR service to access
AWS resources on your behalf.
|
void |
setSteps(Collection<StepConfig> steps)
A list of steps to be executed by the job flow.
|
void |
setSupportedProducts(Collection<String> supportedProducts)
A list of strings that indicates third-party software to use with the
job flow.
|
void |
setTags(Collection<Tag> tags)
A list of tags to associate with a cluster and propagate to Amazon EC2
instances.
|
void |
setVisibleToAllUsers(Boolean visibleToAllUsers)
Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RunJobFlowRequest |
withAdditionalInfo(String additionalInfo)
A JSON string for selecting additional features.
|
RunJobFlowRequest |
withAmiVersion(String amiVersion)
The version of the Amazon Machine Image (AMI) to use when launching
Amazon EC2 instances in the job flow.
|
RunJobFlowRequest |
withBootstrapActions(BootstrapActionConfig... bootstrapActions)
A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.
|
RunJobFlowRequest |
withBootstrapActions(Collection<BootstrapActionConfig> bootstrapActions)
A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.
|
RunJobFlowRequest |
withInstances(JobFlowInstancesConfig instances)
A specification of the number and type of Amazon EC2 instances on
which to run the job flow.
|
RunJobFlowRequest |
withJobFlowRole(String jobFlowRole)
An IAM role for the job flow.
|
RunJobFlowRequest |
withLogUri(String logUri)
The location in Amazon S3 to write the log files of the job flow.
|
RunJobFlowRequest |
withName(String name)
The name of the job flow.
|
RunJobFlowRequest |
withNewSupportedProducts(Collection<SupportedProductConfig> newSupportedProducts)
A list of strings that indicates third-party software to use with the
job flow that accepts a user argument list.
|
RunJobFlowRequest |
withNewSupportedProducts(SupportedProductConfig... newSupportedProducts)
A list of strings that indicates third-party software to use with the
job flow that accepts a user argument list.
|
RunJobFlowRequest |
withServiceRole(String serviceRole)
The IAM role that will be assumed by the Amazon EMR service to access
AWS resources on your behalf.
|
RunJobFlowRequest |
withSteps(Collection<StepConfig> steps)
A list of steps to be executed by the job flow.
|
RunJobFlowRequest |
withSteps(StepConfig... steps)
A list of steps to be executed by the job flow.
|
RunJobFlowRequest |
withSupportedProducts(Collection<String> supportedProducts)
A list of strings that indicates third-party software to use with the
job flow.
|
RunJobFlowRequest |
withSupportedProducts(String... supportedProducts)
A list of strings that indicates third-party software to use with the
job flow.
|
RunJobFlowRequest |
withTags(Collection<Tag> tags)
A list of tags to associate with a cluster and propagate to Amazon EC2
instances.
|
RunJobFlowRequest |
withTags(Tag... tags)
A list of tags to associate with a cluster and propagate to Amazon EC2
instances.
|
RunJobFlowRequest |
withVisibleToAllUsers(Boolean visibleToAllUsers)
Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public RunJobFlowRequest()
public RunJobFlowRequest(String name, JobFlowInstancesConfig instances)
name
- The name of the job flow.instances
- A specification of the number and type of Amazon EC2
instances on which to run the job flow.public String getName()
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setName(String name)
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
name
- The name of the job flow.public RunJobFlowRequest withName(String name)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
name
- The name of the job flow.public String getLogUri()
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setLogUri(String logUri)
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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.public RunJobFlowRequest withLogUri(String logUri)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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.public String getAdditionalInfo()
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setAdditionalInfo(String additionalInfo)
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
additionalInfo
- A JSON string for selecting additional features.public RunJobFlowRequest withAdditionalInfo(String additionalInfo)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
additionalInfo
- A JSON string for selecting additional features.public String getAmiVersion()
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, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
public void setAmiVersion(String amiVersion)
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, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
amiVersion
- The version of the Amazon Machine Image (AMI) to use when launching
Amazon EC2 instances in the job flow. The following values are valid:
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, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
public RunJobFlowRequest withAmiVersion(String amiVersion)
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, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
amiVersion
- The version of the Amazon Machine Image (AMI) to use when launching
Amazon EC2 instances in the job flow. The following values are valid:
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, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
public JobFlowInstancesConfig getInstances()
public void setInstances(JobFlowInstancesConfig instances)
instances
- A specification of the number and type of Amazon EC2 instances on
which to run the job flow.public RunJobFlowRequest withInstances(JobFlowInstancesConfig instances)
Returns a reference to this object so that method calls can be chained together.
instances
- A specification of the number and type of Amazon EC2 instances on
which to run the job flow.public List<StepConfig> getSteps()
public void setSteps(Collection<StepConfig> steps)
steps
- A list of steps to be executed by the job flow.public RunJobFlowRequest withSteps(StepConfig... steps)
Returns a reference to this object so that method calls can be chained together.
steps
- A list of steps to be executed by the job flow.public RunJobFlowRequest withSteps(Collection<StepConfig> steps)
Returns a reference to this object so that method calls can be chained together.
steps
- A list of steps to be executed by the job flow.public List<BootstrapActionConfig> getBootstrapActions()
public void setBootstrapActions(Collection<BootstrapActionConfig> bootstrapActions)
bootstrapActions
- A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.public RunJobFlowRequest withBootstrapActions(BootstrapActionConfig... bootstrapActions)
Returns a reference to this object so that method calls can be chained together.
bootstrapActions
- A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.public RunJobFlowRequest withBootstrapActions(Collection<BootstrapActionConfig> bootstrapActions)
Returns a reference to this object so that method calls can be chained together.
bootstrapActions
- A list of bootstrap actions that will be run before Hadoop is started
on the cluster nodes.public List<String> getSupportedProducts()
public void setSupportedProducts(Collection<String> supportedProducts)
supportedProducts
- A list of strings that indicates third-party software to use with the
job flow. For more information, go to Use
Third Party Applications with Amazon EMR. Currently supported
values are: public RunJobFlowRequest withSupportedProducts(String... supportedProducts)
Returns a reference to this object so that method calls can be chained together.
supportedProducts
- A list of strings that indicates third-party software to use with the
job flow. For more information, go to Use
Third Party Applications with Amazon EMR. Currently supported
values are: public RunJobFlowRequest withSupportedProducts(Collection<String> supportedProducts)
Returns a reference to this object so that method calls can be chained together.
supportedProducts
- A list of strings that indicates third-party software to use with the
job flow. For more information, go to Use
Third Party Applications with Amazon EMR. Currently supported
values are: public List<SupportedProductConfig> getNewSupportedProducts()
public void setNewSupportedProducts(Collection<SupportedProductConfig> newSupportedProducts)
newSupportedProducts
- 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. Currently
supported values are: public RunJobFlowRequest withNewSupportedProducts(SupportedProductConfig... newSupportedProducts)
Returns a reference to this object so that method calls can be chained together.
newSupportedProducts
- 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. Currently
supported values are: public RunJobFlowRequest withNewSupportedProducts(Collection<SupportedProductConfig> newSupportedProducts)
Returns a reference to this object so that method calls can be chained together.
newSupportedProducts
- 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. Currently
supported values are: public Boolean isVisibleToAllUsers()
true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.public void setVisibleToAllUsers(Boolean visibleToAllUsers)
true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.visibleToAllUsers
- Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow. 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 job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.public RunJobFlowRequest withVisibleToAllUsers(Boolean visibleToAllUsers)
true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.
Returns a reference to this object so that method calls can be chained together.
visibleToAllUsers
- Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow. 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 job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.public Boolean getVisibleToAllUsers()
true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.public String getJobFlowRole()
EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.public void setJobFlowRole(String jobFlowRole)
EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
jobFlowRole
- An IAM role for the job flow. The EC2 instances of the job flow assume
this role. The default role is EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.public RunJobFlowRequest withJobFlowRole(String jobFlowRole)
EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
jobFlowRole
- An IAM role for the job flow. The EC2 instances of the job flow assume
this role. The default role is EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.public String getServiceRole()
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
public void setServiceRole(String serviceRole)
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
serviceRole
- The IAM role that will be assumed by the Amazon EMR service to access
AWS resources on your behalf.public RunJobFlowRequest withServiceRole(String serviceRole)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
serviceRole
- The IAM role that will be assumed by the Amazon EMR service to access
AWS resources on your behalf.public List<Tag> getTags()
public void setTags(Collection<Tag> tags)
tags
- A list of tags to associate with a cluster and propagate to Amazon EC2
instances.public RunJobFlowRequest withTags(Tag... tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags to associate with a cluster and propagate to Amazon EC2
instances.public RunJobFlowRequest withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags to associate with a cluster and propagate to Amazon EC2
instances.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.