AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the RunJobFlow operation.
RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the
steps specified. After the steps complete, the cluster stops 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 cluster transitions to the WAITING state rather
than shutting down after the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig TerminationProtected
parameter to TRUE
to lock the cluster 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 cluster 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 long-running clusters, we recommend that you periodically store your results.
The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
Namespace: Amazon.ElasticMapReduce.Model
Assembly: AWSSDK.ElasticMapReduce.dll
Version: 3.x.y.z
public class RunJobFlowRequest : AmazonElasticMapReduceRequest IAmazonWebServiceRequest
The RunJobFlowRequest type exposes the following members
Name | Description | |
---|---|---|
RunJobFlowRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
RunJobFlowRequest(string, JobFlowInstancesConfig) |
Instantiates RunJobFlowRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
AdditionalInfo | System.String |
Gets and sets the property AdditionalInfo. A JSON string for selecting additional features. |
|
AmiVersion | System.String |
Gets and sets the property AmiVersion.
Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and
later, |
|
Applications | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.Application> |
Gets and sets the property 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 EMRRelease Guide. |
|
AutoScalingRole | System.String |
Gets and sets the property AutoScalingRole.
An IAM role for automatic scaling policies. The default role is |
|
AutoTerminationPolicy | Amazon.ElasticMapReduce.Model.AutoTerminationPolicy |
Gets and sets the property AutoTerminationPolicy. |
|
BootstrapActions | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.BootstrapActionConfig> |
Gets and sets the property BootstrapActions. A list of bootstrap actions to run before Hadoop starts on the cluster nodes. |
|
Configurations | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.Configuration> |
Gets and sets the property Configurations. For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating. |
|
CustomAmiId | System.String |
Gets and sets the property CustomAmiId.
Available only in Amazon EMR releases 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 Amazon
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 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. |
|
EbsRootVolumeIops | System.Int32 |
Gets and sets the property EbsRootVolumeIops. The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later. |
|
EbsRootVolumeSize | System.Int32 |
Gets and sets the property EbsRootVolumeSize. The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later. |
|
EbsRootVolumeThroughput | System.Int32 |
Gets and sets the property EbsRootVolumeThroughput. The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later. |
|
Instances | Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig |
Gets and sets the property Instances. A specification of the number and type of Amazon EC2 instances. |
|
JobFlowRole | System.String |
Gets and sets the property JobFlowRole.
Also called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster.
The Amazon EC2 instances of the cluster assume this role. The default role is |
|
KerberosAttributes | Amazon.ElasticMapReduce.Model.KerberosAttributes |
Gets and sets the property 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. |
|
LogEncryptionKmsKeyId | System.String |
Gets and sets the property LogEncryptionKmsKeyId. 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 releases 5.30.0 and later, excluding Amazon EMR 6.0.0. |
|
LogUri | System.String |
Gets and sets the property 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. |
|
ManagedScalingPolicy | Amazon.ElasticMapReduce.Model.ManagedScalingPolicy |
Gets and sets the property ManagedScalingPolicy. The specified managed scaling policy for an Amazon EMR cluster. |
|
Name | System.String |
Gets and sets the property Name. The name of the job flow. |
|
NewSupportedProducts | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.SupportedProductConfig> |
Gets and sets the property 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. Amazon 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:
|
|
OSReleaseLabel | System.String |
Gets and sets the property OSReleaseLabel. 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. |
|
PlacementGroupConfigs | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.PlacementGroupConfig> |
Gets and sets the property PlacementGroupConfigs. The specified placement group configuration for an Amazon EMR cluster. |
|
ReleaseLabel | System.String |
Gets and sets the property 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 |
|
RepoUpgradeOnBoot | Amazon.ElasticMapReduce.RepoUpgradeOnBoot |
Gets and sets the property RepoUpgradeOnBoot.
Applies only when |
|
ScaleDownBehavior | Amazon.ElasticMapReduce.ScaleDownBehavior |
Gets and sets the property ScaleDownBehavior.
Specifies the way that individual Amazon EC2 instances terminate when an automatic
scale-in activity occurs or an instance group is resized. |
|
SecurityConfiguration | System.String |
Gets and sets the property SecurityConfiguration. The name of a security configuration to apply to the cluster. |
|
ServiceRole | System.String |
Gets and sets the property ServiceRole. The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you've created a custom service role path, you must specify it for the service role when you launch your cluster. |
|
StepConcurrencyLevel | System.Int32 |
Gets and sets the property StepConcurrencyLevel.
Specifies the number of steps that can be executed concurrently. The default value
is |
|
Steps | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.StepConfig> |
Gets and sets the property Steps. A list of steps to run. |
|
SupportedProducts | System.Collections.Generic.List<System.String> |
Gets and sets the property 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:
|
|
Tags | System.Collections.Generic.List<Amazon.ElasticMapReduce.Model.Tag> |
Gets and sets the property Tags. A list of tags to associate with a cluster and propagate to Amazon EC2 instances. |
|
VisibleToAllUsers | System.Boolean |
Gets and sets the property VisibleToAllUsers.
The VisibleToAllUsers parameter is no longer supported. By default, the value is set
to
Set this value to
When set to |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5