@Generated(value="software.amazon.awssdk:codegen") public final class RunJobFlowRequest extends EmrRequest implements ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
Input to the RunJobFlow operation.
Modifier and Type | Class and Description |
---|---|
static interface |
RunJobFlowRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
additionalInfo()
A JSON string for selecting additional features.
|
String |
amiVersion()
Applies only to Amazon EMR AMI versions 3.x and 2.x.
|
List<Application> |
applications()
Applies to Amazon EMR releases 4.0 and later.
|
String |
autoScalingRole()
An IAM role for automatic scaling policies.
|
AutoTerminationPolicy |
autoTerminationPolicy()
Returns the value of the AutoTerminationPolicy property for this object.
|
List<BootstrapActionConfig> |
bootstrapActions()
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
|
static RunJobFlowRequest.Builder |
builder() |
List<Configuration> |
configurations()
For Amazon EMR releases 4.0 and later.
|
String |
customAmiId()
Available only in Amazon EMR version 5.7.0 and later.
|
Integer |
ebsRootVolumeSize()
The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasApplications()
For responses, this returns true if the service returned a value for the Applications property.
|
boolean |
hasBootstrapActions()
For responses, this returns true if the service returned a value for the BootstrapActions property.
|
boolean |
hasConfigurations()
For responses, this returns true if the service returned a value for the Configurations property.
|
int |
hashCode() |
boolean |
hasNewSupportedProducts()
For responses, this returns true if the service returned a value for the NewSupportedProducts property.
|
boolean |
hasPlacementGroupConfigs()
For responses, this returns true if the service returned a value for the PlacementGroupConfigs property.
|
boolean |
hasSteps()
For responses, this returns true if the service returned a value for the Steps property.
|
boolean |
hasSupportedProducts()
For responses, this returns true if the service returned a value for the SupportedProducts property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
JobFlowInstancesConfig |
instances()
A specification of the number and type of Amazon EC2 instances.
|
String |
jobFlowRole()
Also called instance profile and EC2 role.
|
KerberosAttributes |
kerberosAttributes()
Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
|
String |
logEncryptionKmsKeyId()
The KMS key used for encrypting log files.
|
String |
logUri()
The location in Amazon S3 to write the log files of the job flow.
|
ManagedScalingPolicy |
managedScalingPolicy()
The specified managed scaling policy for an Amazon EMR cluster.
|
String |
name()
The name of the job flow.
|
List<SupportedProductConfig> |
newSupportedProducts()
|
String |
osReleaseLabel()
Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request.
|
List<PlacementGroupConfig> |
placementGroupConfigs()
The specified placement group configuration for an Amazon EMR cluster.
|
String |
releaseLabel()
The Amazon EMR release label, which determines the version of open-source application packages installed on the
cluster.
|
RepoUpgradeOnBoot |
repoUpgradeOnBoot()
Applies only when
CustomAmiID is used. |
String |
repoUpgradeOnBootAsString()
Applies only when
CustomAmiID is used. |
ScaleDownBehavior |
scaleDownBehavior()
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an
instance group is resized.
|
String |
scaleDownBehaviorAsString()
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an
instance group is resized.
|
List<SdkField<?>> |
sdkFields() |
String |
securityConfiguration()
The name of a security configuration to apply to the cluster.
|
static Class<? extends RunJobFlowRequest.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
|
Integer |
stepConcurrencyLevel()
Specifies the number of steps that can be executed concurrently.
|
List<StepConfig> |
steps()
A list of steps to run.
|
List<String> |
supportedProducts()
|
List<Tag> |
tags()
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
|
RunJobFlowRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
visibleToAllUsers()
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String name()
The name of the job flow.
public final 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.
public final 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.
public final String additionalInfo()
A JSON string for selecting additional features.
public final 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
.
ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.public final 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
.
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
.public final JobFlowInstancesConfig instances()
A specification of the number and type of Amazon EC2 instances.
public final boolean hasSteps()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<StepConfig> steps()
A list of steps to run.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSteps()
method.
public final boolean hasBootstrapActions()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<BootstrapActionConfig> bootstrapActions()
A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasBootstrapActions()
method.
public final boolean hasSupportedProducts()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSupportedProducts()
method.
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.
public final boolean hasNewSupportedProducts()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasNewSupportedProducts()
method.
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.
public final boolean hasApplications()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasApplications()
method.
public final boolean hasConfigurations()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<Configuration> configurations()
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasConfigurations()
method.
public final 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.
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.
public final 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.
EMR_EC2_DefaultRole
. In order to use the
default role, you must have already created it using the CLI or console.public final String serviceRole()
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
public final boolean hasTags()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags()
method.
public final String securityConfiguration()
The name of a security configuration to apply to the cluster.
public final 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.
EMR_AutoScaling_DefaultRole
.
The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2
instances in an instance group.public final 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.
If the service returns an enum value that is not available in the current SDK version, scaleDownBehavior
will return ScaleDownBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from scaleDownBehaviorAsString()
.
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
public final String scaleDownBehaviorAsString()
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.
If the service returns an enum value that is not available in the current SDK version, scaleDownBehavior
will return ScaleDownBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from scaleDownBehaviorAsString()
.
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
public final 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.
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.
public final 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.
public final 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.
If the service returns an enum value that is not available in the current SDK version, repoUpgradeOnBoot
will return RepoUpgradeOnBoot.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from repoUpgradeOnBootAsString()
.
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
public final String repoUpgradeOnBootAsString()
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.
If the service returns an enum value that is not available in the current SDK version, repoUpgradeOnBoot
will return RepoUpgradeOnBoot.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from repoUpgradeOnBootAsString()
.
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
public final 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.
public final Integer stepConcurrencyLevel()
Specifies the number of steps that can be executed concurrently. The default value is 1
. The maximum
value is 256
.
1
. The
maximum value is 256
.public final ManagedScalingPolicy managedScalingPolicy()
The specified managed scaling policy for an Amazon EMR cluster.
public final boolean hasPlacementGroupConfigs()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<PlacementGroupConfig> placementGroupConfigs()
The specified placement group configuration for an Amazon EMR cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPlacementGroupConfigs()
method.
public final AutoTerminationPolicy autoTerminationPolicy()
public final 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.
public RunJobFlowRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
toBuilder
in class EmrRequest
public static RunJobFlowRequest.Builder builder()
public static Class<? extends RunJobFlowRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.