Interface RunJobFlowRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RunJobFlowRequest.Builder,
,RunJobFlowRequest> EmrRequest.Builder
,SdkBuilder<RunJobFlowRequest.Builder,
,RunJobFlowRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RunJobFlowRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalInfo
(String additionalInfo) A JSON string for selecting additional features.amiVersion
(String amiVersion) Applies only to Amazon EMR AMI versions 3.x and 2.x.applications
(Collection<Application> applications) Applies to Amazon EMR releases 4.0 and later.applications
(Consumer<Application.Builder>... applications) Applies to Amazon EMR releases 4.0 and later.applications
(Application... applications) Applies to Amazon EMR releases 4.0 and later.autoScalingRole
(String autoScalingRole) An IAM role for automatic scaling policies.default RunJobFlowRequest.Builder
autoTerminationPolicy
(Consumer<AutoTerminationPolicy.Builder> autoTerminationPolicy) Sets the value of the AutoTerminationPolicy property for this object.autoTerminationPolicy
(AutoTerminationPolicy autoTerminationPolicy) Sets the value of the AutoTerminationPolicy property for this object.bootstrapActions
(Collection<BootstrapActionConfig> bootstrapActions) A list of bootstrap actions to run before Hadoop starts on the cluster nodes.bootstrapActions
(Consumer<BootstrapActionConfig.Builder>... bootstrapActions) A list of bootstrap actions to run before Hadoop starts on the cluster nodes.bootstrapActions
(BootstrapActionConfig... bootstrapActions) A list of bootstrap actions to run before Hadoop starts on the cluster nodes.configurations
(Collection<Configuration> configurations) For Amazon EMR releases 4.0 and later.configurations
(Consumer<Configuration.Builder>... configurations) For Amazon EMR releases 4.0 and later.configurations
(Configuration... configurations) For Amazon EMR releases 4.0 and later.customAmiId
(String customAmiId) Available only in Amazon EMR releases 5.7.0 and later.ebsRootVolumeIops
(Integer ebsRootVolumeIops) The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.ebsRootVolumeSize
(Integer ebsRootVolumeSize) The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.ebsRootVolumeThroughput
(Integer 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.default RunJobFlowRequest.Builder
instances
(Consumer<JobFlowInstancesConfig.Builder> instances) A specification of the number and type of Amazon EC2 instances.instances
(JobFlowInstancesConfig instances) A specification of the number and type of Amazon EC2 instances.jobFlowRole
(String jobFlowRole) Also called instance profile and Amazon EC2 role.default RunJobFlowRequest.Builder
kerberosAttributes
(Consumer<KerberosAttributes.Builder> kerberosAttributes) Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.kerberosAttributes
(KerberosAttributes kerberosAttributes) Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.logEncryptionKmsKeyId
(String logEncryptionKmsKeyId) The KMS key used for encrypting log files.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.managedScalingPolicy
(ManagedScalingPolicy managedScalingPolicy) The specified managed scaling policy for an Amazon EMR cluster.The name of the job flow.newSupportedProducts
(Collection<SupportedProductConfig> newSupportedProducts) newSupportedProducts
(Consumer<SupportedProductConfig.Builder>... newSupportedProducts) newSupportedProducts
(SupportedProductConfig... newSupportedProducts) osReleaseLabel
(String osReleaseLabel) Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.placementGroupConfigs
(Collection<PlacementGroupConfig> placementGroupConfigs) The specified placement group configuration for an Amazon EMR cluster.placementGroupConfigs
(Consumer<PlacementGroupConfig.Builder>... placementGroupConfigs) The specified placement group configuration for an Amazon EMR cluster.placementGroupConfigs
(PlacementGroupConfig... placementGroupConfigs) The specified placement group configuration for an Amazon EMR cluster.releaseLabel
(String releaseLabel) The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.repoUpgradeOnBoot
(String repoUpgradeOnBoot) Applies only whenCustomAmiID
is used.repoUpgradeOnBoot
(RepoUpgradeOnBoot repoUpgradeOnBoot) Applies only whenCustomAmiID
is used.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.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.securityConfiguration
(String securityConfiguration) The name of a security configuration to apply to the cluster.serviceRole
(String serviceRole) The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.stepConcurrencyLevel
(Integer stepConcurrencyLevel) Specifies the number of steps that can be executed concurrently.steps
(Collection<StepConfig> steps) A list of steps to run.steps
(Consumer<StepConfig.Builder>... steps) A list of steps to run.steps
(StepConfig... steps) A list of steps to run.supportedProducts
(String... supportedProducts) supportedProducts
(Collection<String> supportedProducts) tags
(Collection<Tag> tags) A list of tags to associate with a cluster and propagate to Amazon EC2 instances.tags
(Consumer<Tag.Builder>... tags) A list of tags to associate with a cluster and propagate to Amazon EC2 instances.A list of tags to associate with a cluster and propagate to Amazon EC2 instances.visibleToAllUsers
(Boolean visibleToAllUsers) Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.emr.model.EmrRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the job flow.
- Parameters:
name
- The name of the job flow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
logUri
- The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalInfo
A JSON string for selecting additional features.
- Parameters:
additionalInfo
- A JSON string for selecting additional features.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, useCustomAmiID
.- Parameters:
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, useCustomAmiID
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 asemr-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 useAmiVersion
.- Parameters:
releaseLabel
- The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the formemr-x.x.x
, where x.x.x is an Amazon EMR release version such asemr-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 useAmiVersion
.- Returns:
- 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.
- Parameters:
instances
- A specification of the number and type of Amazon EC2 instances.- Returns:
- 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.
This is a convenience method that creates an instance of theJobFlowInstancesConfig.Builder
avoiding the need to create one manually viaJobFlowInstancesConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstances(JobFlowInstancesConfig)
.- Parameters:
instances
- a consumer that will call methods onJobFlowInstancesConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
steps
A list of steps to run.
- Parameters:
steps
- A list of steps to run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
steps
A list of steps to run.
- Parameters:
steps
- A list of steps to run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaStepConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosteps(List<StepConfig>)
.- Parameters:
steps
- a consumer that will call methods onStepConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bootstrapActions
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
- Parameters:
bootstrapActions
- A list of bootstrap actions to run before Hadoop starts on the cluster nodes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bootstrapActions
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
- Parameters:
bootstrapActions
- A list of bootstrap actions to run before Hadoop starts on the cluster nodes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bootstrapActions
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 viaBootstrapActionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobootstrapActions(List<BootstrapActionConfig>)
.- Parameters:
bootstrapActions
- a consumer that will call methods onBootstrapActionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
newSupportedProducts
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. 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:
-
"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.
- Parameters:
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:
-
"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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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:
-
"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.
- Parameters:
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:
-
"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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
newSupportedProducts
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. 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:
-
"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 viaSupportedProductConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonewSupportedProducts(List<SupportedProductConfig>)
.- Parameters:
newSupportedProducts
- a consumer that will call methods onSupportedProductConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaApplication.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toapplications(List<Application>)
.- Parameters:
applications
- a consumer that will call methods onApplication.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
configurations
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
- Parameters:
configurations
- For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurations
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
- Parameters:
configurations
- For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurations
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
This is a convenience method that creates an instance of theConfiguration.Builder
avoiding the need to create one manually viaConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfigurations(List<Configuration>)
.- Parameters:
configurations
- a consumer that will call methods onConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
visibleToAllUsers
The VisibleToAllUsers parameter is no longer supported. By default, the value is set to
true
. Setting it tofalse
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 Amazon EMR actions on the cluster that their IAM policies allow. This value defaults totrue
for clusters created using the Amazon 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 Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.- Parameters:
visibleToAllUsers
-The VisibleToAllUsers parameter is no longer supported. By default, the value is set to
true
. Setting it tofalse
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 Amazon EMR actions on the cluster that their IAM policies allow. This value defaults totrue
for clusters created using the Amazon 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 Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
EMR_EC2_DefaultRole
. In order to use the default role, you must have already created it using the CLI or console.- Parameters:
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 isEMR_EC2_DefaultRole
. In order to use the default role, you must have already created it using the CLI or console.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- 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.
- Parameters:
tags
- A list of tags to associate with a cluster and propagate to Amazon EC2 instances.- Returns:
- 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.
- Parameters:
tags
- A list of tags to associate with a cluster and propagate to Amazon EC2 instances.- Returns:
- 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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
securityConfiguration
The name of a security configuration to apply to the cluster.
- Parameters:
securityConfiguration
- The name of a security configuration to apply to the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Amazon EC2 instances in an instance group.- Parameters:
autoScalingRole
- An IAM role for automatic scaling policies. The default role isEMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.- Parameters:
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 releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.- Parameters:
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 releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
ReleaseLabel
specified. For Amazon EMR releases 2.x and 3.x, useAmiVersion
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.
- Parameters:
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 theReleaseLabel
specified. For Amazon EMR releases 2.x and 3.x, useAmiVersion
instead.For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isSECURITY
, which indicates that only security updates are applied. IfNONE
is specified, no updates are applied, and all updates must be applied manually.- Parameters:
repoUpgradeOnBoot
- Applies only whenCustomAmiID
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 isSECURITY
, which indicates that only security updates are applied. IfNONE
is specified, no updates are applied, and all updates must be applied manually.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isSECURITY
, which indicates that only security updates are applied. IfNONE
is specified, no updates are applied, and all updates must be applied manually.- Parameters:
repoUpgradeOnBoot
- Applies only whenCustomAmiID
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 isSECURITY
, which indicates that only security updates are applied. IfNONE
is specified, no updates are applied, and all updates must be applied manually.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kerberosAttributes
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 viaKerberosAttributes.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokerberosAttributes(KerberosAttributes)
.- Parameters:
kerberosAttributes
- a consumer that will call methods onKerberosAttributes.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stepConcurrencyLevel
Specifies the number of steps that can be executed concurrently. The default value is
1
. The maximum value is256
.- Parameters:
stepConcurrencyLevel
- Specifies the number of steps that can be executed concurrently. The default value is1
. The maximum value is256
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
managedScalingPolicy
The specified managed scaling policy for an Amazon EMR cluster.
- Parameters:
managedScalingPolicy
- The specified managed scaling policy for an Amazon EMR cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
managedScalingPolicy
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 viaManagedScalingPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanagedScalingPolicy(ManagedScalingPolicy)
.- Parameters:
managedScalingPolicy
- a consumer that will call methods onManagedScalingPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
placementGroupConfigs
RunJobFlowRequest.Builder placementGroupConfigs(Collection<PlacementGroupConfig> placementGroupConfigs) The specified placement group configuration for an Amazon EMR cluster.
- Parameters:
placementGroupConfigs
- The specified placement group configuration for an Amazon EMR cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placementGroupConfigs
The specified placement group configuration for an Amazon EMR cluster.
- Parameters:
placementGroupConfigs
- The specified placement group configuration for an Amazon EMR cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placementGroupConfigs
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 viaPlacementGroupConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplacementGroupConfigs(List<PlacementGroupConfig>)
.- Parameters:
placementGroupConfigs
- a consumer that will call methods onPlacementGroupConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
autoTerminationPolicy
Sets the value of the AutoTerminationPolicy property for this object.- Parameters:
autoTerminationPolicy
- The new value for the AutoTerminationPolicy property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoTerminationPolicy
default RunJobFlowRequest.Builder autoTerminationPolicy(Consumer<AutoTerminationPolicy.Builder> autoTerminationPolicy) Sets the value of the AutoTerminationPolicy property for this object. This is a convenience method that creates an instance of theAutoTerminationPolicy.Builder
avoiding the need to create one manually viaAutoTerminationPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoTerminationPolicy(AutoTerminationPolicy)
.- Parameters:
autoTerminationPolicy
- a consumer that will call methods onAutoTerminationPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
RunJobFlowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
RunJobFlowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-