public static interface RunJobFlowRequest.Builder extends EmrRequest.Builder, SdkPojo, CopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
Modifier and Type | Method and Description |
---|---|
RunJobFlowRequest.Builder |
additionalInfo(String additionalInfo)
A JSON string for selecting additional features.
|
RunJobFlowRequest.Builder |
amiVersion(String amiVersion)
Applies only to Amazon EMR AMI versions 3.x and 2.x.
|
RunJobFlowRequest.Builder |
applications(Application... applications)
Applies to Amazon EMR releases 4.0 and later.
|
RunJobFlowRequest.Builder |
applications(Collection<Application> applications)
Applies to Amazon EMR releases 4.0 and later.
|
RunJobFlowRequest.Builder |
applications(Consumer<Application.Builder>... applications)
Applies to Amazon EMR releases 4.0 and later.
|
RunJobFlowRequest.Builder |
autoScalingRole(String autoScalingRole)
An IAM role for automatic scaling policies.
|
RunJobFlowRequest.Builder |
autoTerminationPolicy(AutoTerminationPolicy autoTerminationPolicy)
Sets the value of the AutoTerminationPolicy property for this object.
|
default RunJobFlowRequest.Builder |
autoTerminationPolicy(Consumer<AutoTerminationPolicy.Builder> autoTerminationPolicy)
Sets the value of the AutoTerminationPolicy property for this object.
|
RunJobFlowRequest.Builder |
bootstrapActions(BootstrapActionConfig... bootstrapActions)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
RunJobFlowRequest.Builder |
bootstrapActions(Collection<BootstrapActionConfig> bootstrapActions)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
RunJobFlowRequest.Builder |
bootstrapActions(Consumer<BootstrapActionConfig.Builder>... bootstrapActions)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
RunJobFlowRequest.Builder |
configurations(Collection<Configuration> configurations)
For Amazon EMR releases 4.0 and later.
|
RunJobFlowRequest.Builder |
configurations(Configuration... configurations)
For Amazon EMR releases 4.0 and later.
|
RunJobFlowRequest.Builder |
configurations(Consumer<Configuration.Builder>... configurations)
For Amazon EMR releases 4.0 and later.
|
RunJobFlowRequest.Builder |
customAmiId(String customAmiId)
Available only in Amazon EMR version 5.7.0 and later.
|
RunJobFlowRequest.Builder |
ebsRootVolumeSize(Integer ebsRootVolumeSize)
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance.
|
default RunJobFlowRequest.Builder |
instances(Consumer<JobFlowInstancesConfig.Builder> instances)
A specification of the number and type of Amazon EC2 instances.
|
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.
|
default RunJobFlowRequest.Builder |
kerberosAttributes(Consumer<KerberosAttributes.Builder> kerberosAttributes)
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
|
RunJobFlowRequest.Builder |
kerberosAttributes(KerberosAttributes kerberosAttributes)
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
|
RunJobFlowRequest.Builder |
logEncryptionKmsKeyId(String logEncryptionKmsKeyId)
The KMS key used for encrypting log files.
|
RunJobFlowRequest.Builder |
logUri(String logUri)
The location in Amazon S3 to write the log files of the job flow.
|
default RunJobFlowRequest.Builder |
managedScalingPolicy(Consumer<ManagedScalingPolicy.Builder> managedScalingPolicy)
The specified managed scaling policy for an Amazon EMR cluster.
|
RunJobFlowRequest.Builder |
managedScalingPolicy(ManagedScalingPolicy managedScalingPolicy)
The specified managed scaling policy for an Amazon EMR cluster.
|
RunJobFlowRequest.Builder |
name(String name)
The name of the job flow.
|
RunJobFlowRequest.Builder |
newSupportedProducts(Collection<SupportedProductConfig> newSupportedProducts)
|
RunJobFlowRequest.Builder |
newSupportedProducts(Consumer<SupportedProductConfig.Builder>... newSupportedProducts)
|
RunJobFlowRequest.Builder |
newSupportedProducts(SupportedProductConfig... newSupportedProducts)
|
RunJobFlowRequest.Builder |
osReleaseLabel(String osReleaseLabel)
Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request.
|
RunJobFlowRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RunJobFlowRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RunJobFlowRequest.Builder |
placementGroupConfigs(Collection<PlacementGroupConfig> placementGroupConfigs)
The specified placement group configuration for an Amazon EMR cluster.
|
RunJobFlowRequest.Builder |
placementGroupConfigs(Consumer<PlacementGroupConfig.Builder>... placementGroupConfigs)
The specified placement group configuration for an Amazon EMR cluster.
|
RunJobFlowRequest.Builder |
placementGroupConfigs(PlacementGroupConfig... placementGroupConfigs)
The specified placement group configuration for an Amazon EMR cluster.
|
RunJobFlowRequest.Builder |
releaseLabel(String releaseLabel)
The Amazon EMR release label, which determines the version of open-source application packages installed on
the cluster.
|
RunJobFlowRequest.Builder |
repoUpgradeOnBoot(RepoUpgradeOnBoot repoUpgradeOnBoot)
Applies only when
CustomAmiID is used. |
RunJobFlowRequest.Builder |
repoUpgradeOnBoot(String repoUpgradeOnBoot)
Applies only when
CustomAmiID is used. |
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 |
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 |
securityConfiguration(String securityConfiguration)
The name of a security configuration to apply to the cluster.
|
RunJobFlowRequest.Builder |
serviceRole(String serviceRole)
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
|
RunJobFlowRequest.Builder |
stepConcurrencyLevel(Integer stepConcurrencyLevel)
Specifies the number of steps that can be executed concurrently.
|
RunJobFlowRequest.Builder |
steps(Collection<StepConfig> steps)
A list of steps to run.
|
RunJobFlowRequest.Builder |
steps(Consumer<StepConfig.Builder>... steps)
A list of steps to run.
|
RunJobFlowRequest.Builder |
steps(StepConfig... steps)
A list of steps to run.
|
RunJobFlowRequest.Builder |
supportedProducts(Collection<String> supportedProducts)
|
RunJobFlowRequest.Builder |
supportedProducts(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(Consumer<Tag.Builder>... 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)
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
RunJobFlowRequest.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 logEncryptionKmsKeyId(String 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 version 5.30.0 and later, excluding Amazon EMR 6.0.0.
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 version 5.30.0 and later, excluding Amazon
EMR 6.0.0.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)
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
.
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
.RunJobFlowRequest.Builder releaseLabel(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 such as emr-5.14.0
. For more information about Amazon EMR release versions and included
application versions and features, see https://
docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases
version 4.0 and later. Earlier versions use AmiVersion
.
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 such as emr-5.14.0
. For more information about Amazon EMR
release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon
EMR releases version 4.0 and later. Earlier versions use AmiVersion
.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.default RunJobFlowRequest.Builder instances(Consumer<JobFlowInstancesConfig.Builder> instances)
A specification of the number and type of Amazon EC2 instances.
This is a convenience method that creates an instance of theJobFlowInstancesConfig.Builder
avoiding
the need to create one manually via JobFlowInstancesConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to instances(JobFlowInstancesConfig)
.
instances
- a consumer that will call methods on JobFlowInstancesConfig.Builder
instances(JobFlowInstancesConfig)
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.
steps
- A list of steps to run.RunJobFlowRequest.Builder steps(Consumer<StepConfig.Builder>... steps)
A list of steps to run.
This is a convenience method that creates an instance of theStepConfig.Builder
avoiding the need to create one manually
via StepConfig.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately and its
result is passed to #steps(List
.
steps
- a consumer that will call methods on
StepConfig.Builder
#steps(java.util.Collection)
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.
bootstrapActions
- A list of bootstrap actions to run before Hadoop starts on the cluster nodes.RunJobFlowRequest.Builder bootstrapActions(Consumer<BootstrapActionConfig.Builder>... bootstrapActions)
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
This is a convenience method that creates an instance of theBootstrapActionConfig.Builder
avoiding the need to create
one manually via BootstrapActionConfig.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately
and its result is passed to #bootstrapActions(List
.
bootstrapActions
- a consumer that will call methods on
BootstrapActionConfig.Builder
#bootstrapActions(java.util.Collection)
RunJobFlowRequest.Builder supportedProducts(Collection<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.
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.
RunJobFlowRequest.Builder supportedProducts(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.
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.
RunJobFlowRequest.Builder newSupportedProducts(Collection<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 Analytics 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 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 Analytics 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 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 Analytics 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 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 Analytics 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(Consumer<SupportedProductConfig.Builder>... 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 Analytics 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.
SupportedProductConfig.Builder
avoiding the need to create
one manually via SupportedProductConfig.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called
immediately and its result is passed to #newSupportedProducts(List
.
newSupportedProducts
- a consumer that will call methods on
SupportedProductConfig.Builder
#newSupportedProducts(java.util.Collection)
RunJobFlowRequest.Builder applications(Collection<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 EMRRelease Guide.
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.RunJobFlowRequest.Builder applications(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 EMRRelease Guide.
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.RunJobFlowRequest.Builder applications(Consumer<Application.Builder>... 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.
This is a convenience method that creates an instance of theApplication.Builder
avoiding the need to create one
manually via Application.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately and its
result is passed to #applications(List
.
applications
- a consumer that will call methods on
Application.Builder
#applications(java.util.Collection)
RunJobFlowRequest.Builder configurations(Collection<Configuration> configurations)
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
configurations
- For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are
creating.RunJobFlowRequest.Builder configurations(Configuration... configurations)
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
configurations
- For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are
creating.RunJobFlowRequest.Builder configurations(Consumer<Configuration.Builder>... configurations)
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
This is a convenience method that creates an instance of theConfiguration.Builder
avoiding the need to create one
manually via Configuration.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately and its
result is passed to #configurations(List
.
configurations
- a consumer that will call methods on
Configuration.Builder
#configurations(java.util.Collection)
RunJobFlowRequest.Builder visibleToAllUsers(Boolean visibleToAllUsers)
The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true
.
Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with
the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to
true
for clusters created using the EMR API or the CLI create-cluster command.
When set to false
, only the IAM principal that created the cluster and the Amazon Web Services
account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies
attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.
visibleToAllUsers
-
The VisibleToAllUsers parameter is no longer supported. By default, the value is set to
true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account
associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This
value defaults to true
for clusters created using the EMR API or the CLI create-cluster
command.
When set to false
, only the IAM principal that created the cluster and the Amazon Web
Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions
policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.
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 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.
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.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.
tags
- A list of tags to associate with a cluster and propagate to Amazon EC2 instances.RunJobFlowRequest.Builder tags(Consumer<Tag.Builder>... tags)
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually via
Tag.builder()
.
When the Consumer
completes, SdkBuilder.build()
is
called immediately and its result is passed to #tags(List
.
tags
- a consumer that will call methods on Tag.Builder
#tags(java.util.Collection)
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 adds nodes to a deny list
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 adds nodes to a deny list 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
,
ScaleDownBehavior
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. 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 adds nodes to a deny list
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 adds nodes to a deny list 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
,
ScaleDownBehavior
RunJobFlowRequest.Builder customAmiId(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.
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.
RunJobFlowRequest.Builder ebsRootVolumeSize(Integer ebsRootVolumeSize)
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
ebsRootVolumeSize
- The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2
instance. Available in Amazon EMR version 4.x and later.RunJobFlowRequest.Builder repoUpgradeOnBoot(String 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.
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.RepoUpgradeOnBoot
,
RepoUpgradeOnBoot
RunJobFlowRequest.Builder repoUpgradeOnBoot(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.
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.RepoUpgradeOnBoot
,
RepoUpgradeOnBoot
RunJobFlowRequest.Builder kerberosAttributes(KerberosAttributes 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.
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.default RunJobFlowRequest.Builder kerberosAttributes(Consumer<KerberosAttributes.Builder> 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.
This is a convenience method that creates an instance of theKerberosAttributes.Builder
avoiding the
need to create one manually via KerberosAttributes.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to kerberosAttributes(KerberosAttributes)
.
kerberosAttributes
- a consumer that will call methods on KerberosAttributes.Builder
kerberosAttributes(KerberosAttributes)
RunJobFlowRequest.Builder stepConcurrencyLevel(Integer stepConcurrencyLevel)
Specifies the number of steps that can be executed concurrently. The default value is 1
. The
maximum value is 256
.
stepConcurrencyLevel
- Specifies the number of steps that can be executed concurrently. The default value is 1
.
The maximum value is 256
.RunJobFlowRequest.Builder managedScalingPolicy(ManagedScalingPolicy managedScalingPolicy)
The specified managed scaling policy for an Amazon EMR cluster.
managedScalingPolicy
- The specified managed scaling policy for an Amazon EMR cluster.default RunJobFlowRequest.Builder managedScalingPolicy(Consumer<ManagedScalingPolicy.Builder> managedScalingPolicy)
The specified managed scaling policy for an Amazon EMR cluster.
This is a convenience method that creates an instance of theManagedScalingPolicy.Builder
avoiding
the need to create one manually via ManagedScalingPolicy.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to managedScalingPolicy(ManagedScalingPolicy)
.
managedScalingPolicy
- a consumer that will call methods on ManagedScalingPolicy.Builder
managedScalingPolicy(ManagedScalingPolicy)
RunJobFlowRequest.Builder placementGroupConfigs(Collection<PlacementGroupConfig> placementGroupConfigs)
The specified placement group configuration for an Amazon EMR cluster.
placementGroupConfigs
- The specified placement group configuration for an Amazon EMR cluster.RunJobFlowRequest.Builder placementGroupConfigs(PlacementGroupConfig... placementGroupConfigs)
The specified placement group configuration for an Amazon EMR cluster.
placementGroupConfigs
- The specified placement group configuration for an Amazon EMR cluster.RunJobFlowRequest.Builder placementGroupConfigs(Consumer<PlacementGroupConfig.Builder>... placementGroupConfigs)
The specified placement group configuration for an Amazon EMR cluster.
This is a convenience method that creates an instance of thePlacementGroupConfig.Builder
avoiding the need to create
one manually via PlacementGroupConfig.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately
and its result is passed to #placementGroupConfigs(List
.
placementGroupConfigs
- a consumer that will call methods on
PlacementGroupConfig.Builder
#placementGroupConfigs(java.util.Collection)
RunJobFlowRequest.Builder autoTerminationPolicy(AutoTerminationPolicy autoTerminationPolicy)
autoTerminationPolicy
- The new value for the AutoTerminationPolicy property for this object.default RunJobFlowRequest.Builder autoTerminationPolicy(Consumer<AutoTerminationPolicy.Builder> autoTerminationPolicy)
AutoTerminationPolicy.Builder
avoiding
the need to create one manually via AutoTerminationPolicy.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to autoTerminationPolicy(AutoTerminationPolicy)
.
autoTerminationPolicy
- a consumer that will call methods on AutoTerminationPolicy.Builder
autoTerminationPolicy(AutoTerminationPolicy)
RunJobFlowRequest.Builder osReleaseLabel(String 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.
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.RunJobFlowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
RunJobFlowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.