Class RunJobFlowRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.emr.model.EmrRequest
-
- software.amazon.awssdk.services.emr.model.RunJobFlowRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
@Generated("software.amazon.awssdk:codegen") public final class RunJobFlowRequest extends EmrRequest implements ToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
Input to the RunJobFlow operation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
RunJobFlowRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 releases 5.7.0 and later.Integer
ebsRootVolumeIops()
The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.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.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.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 Amazon 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 whenCustomAmiID
is used.String
repoUpgradeOnBootAsString()
Applies only whenCustomAmiID
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.Map<String,SdkField<?>>
sdkFieldNameToField()
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()
-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the job flow.
- Returns:
- The name of the job flow.
-
logUri
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.
- Returns:
- The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
-
logEncryptionKmsKeyId
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 releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
- Returns:
- 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.
-
additionalInfo
public final String additionalInfo()
A JSON string for selecting additional features.
- Returns:
- A JSON string for selecting additional features.
-
amiVersion
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, useCustomAmiID
.- Returns:
- 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
.
-
releaseLabel
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 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:
- 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
.
-
instances
public final JobFlowInstancesConfig instances()
A specification of the number and type of Amazon EC2 instances.
- Returns:
- A specification of the number and type of Amazon EC2 instances.
-
hasSteps
public final boolean hasSteps()
For responses, this returns true if the service returned a value for the Steps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
steps
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.- Returns:
- A list of steps to run.
-
hasBootstrapActions
public final boolean hasBootstrapActions()
For responses, this returns true if the service returned a value for the BootstrapActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
bootstrapActions
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.- Returns:
- A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
-
hasSupportedProducts
public final boolean hasSupportedProducts()
For responses, this returns true if the service returned a value for the SupportedProducts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
supportedProducts
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.- Returns:
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.
-
-
-
hasNewSupportedProducts
public final boolean hasNewSupportedProducts()
For responses, this returns true if the service returned a value for the NewSupportedProducts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
newSupportedProducts
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. 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.
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.- Returns:
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.
-
-
-
hasApplications
public final boolean hasApplications()
For responses, this returns true if the service returned a value for the Applications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
applications
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.- Returns:
- 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.
-
hasConfigurations
public final boolean hasConfigurations()
For responses, this returns true if the service returned a value for the Configurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
configurations
public final List<Configuration> configurations()
For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that 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.- Returns:
- For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
-
visibleToAllUsers
public final Boolean 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:
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.
-
jobFlowRole
public final String 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.- Returns:
- 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.
-
serviceRole
public final 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.
- Returns:
- 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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
tags
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.- Returns:
- A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
-
securityConfiguration
public final String securityConfiguration()
The name of a security configuration to apply to the cluster.
- Returns:
- The name of a security configuration to apply to the cluster.
-
autoScalingRole
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 Amazon EC2 instances in an instance group.- Returns:
- 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.
-
scaleDownBehavior
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 releases 4.1.0 and later, and is the default for releases 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 returnScaleDownBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscaleDownBehaviorAsString()
.- Returns:
- 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. - See Also:
ScaleDownBehavior
-
scaleDownBehaviorAsString
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 releases 4.1.0 and later, and is the default for releases 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 returnScaleDownBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscaleDownBehaviorAsString()
.- Returns:
- 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. - See Also:
ScaleDownBehavior
-
customAmiId
public final String 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.
- Returns:
- 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.
-
ebsRootVolumeSize
public final 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. Available in Amazon EMR releases 4.x and later.
- Returns:
- 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.
-
repoUpgradeOnBoot
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 isSECURITY
, which indicates that only security updates are applied. IfNONE
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 returnRepoUpgradeOnBoot.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrepoUpgradeOnBootAsString()
.- Returns:
- 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. - See Also:
RepoUpgradeOnBoot
-
repoUpgradeOnBootAsString
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 isSECURITY
, which indicates that only security updates are applied. IfNONE
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 returnRepoUpgradeOnBoot.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrepoUpgradeOnBootAsString()
.- Returns:
- 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. - See Also:
RepoUpgradeOnBoot
-
kerberosAttributes
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.
- Returns:
- 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.
-
stepConcurrencyLevel
public final Integer stepConcurrencyLevel()
Specifies the number of steps that can be executed concurrently. The default value is
1
. The maximum value is256
.- Returns:
- Specifies the number of steps that can be executed concurrently. The default value is
1
. The maximum value is256
.
-
managedScalingPolicy
public final ManagedScalingPolicy managedScalingPolicy()
The specified managed scaling policy for an Amazon EMR cluster.
- Returns:
- The specified managed scaling policy for an Amazon EMR cluster.
-
hasPlacementGroupConfigs
public final boolean hasPlacementGroupConfigs()
For responses, this returns true if the service returned a value for the PlacementGroupConfigs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
placementGroupConfigs
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.- Returns:
- The specified placement group configuration for an Amazon EMR cluster.
-
autoTerminationPolicy
public final AutoTerminationPolicy autoTerminationPolicy()
Returns the value of the AutoTerminationPolicy property for this object.- Returns:
- The value of the AutoTerminationPolicy property for this object.
-
osReleaseLabel
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.
- Returns:
- 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.
-
ebsRootVolumeIops
public final Integer 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:
- 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.
-
ebsRootVolumeThroughput
public final 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. Available in Amazon EMR releases 6.15.0 and later.
- Returns:
- 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.
-
toBuilder
public RunJobFlowRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RunJobFlowRequest.Builder,RunJobFlowRequest>
- Specified by:
toBuilder
in classEmrRequest
-
builder
public static RunJobFlowRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends RunJobFlowRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-