software.amazon.awssdk.services.emr.model

Interface JobFlowInstancesConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<JobFlowInstancesConfig.Builder,JobFlowInstancesConfig>, SdkBuilder<JobFlowInstancesConfig.Builder,JobFlowInstancesConfig>, SdkPojo

Enclosing class:

JobFlowInstancesConfig

public static interface JobFlowInstancesConfig.Builder
extends SdkPojo, CopyableBuilder<JobFlowInstancesConfig.Builder,JobFlowInstancesConfig>

Method Summary

Modifier and Type	Method and Description
JobFlowInstancesConfig.Builder	additionalMasterSecurityGroups(Collection<String> additionalMasterSecurityGroups) A list of additional Amazon EC2 security group IDs for the master node.
JobFlowInstancesConfig.Builder	additionalMasterSecurityGroups(String... additionalMasterSecurityGroups) A list of additional Amazon EC2 security group IDs for the master node.
JobFlowInstancesConfig.Builder	additionalSlaveSecurityGroups(Collection<String> additionalSlaveSecurityGroups) A list of additional Amazon EC2 security group IDs for the core and task nodes.
JobFlowInstancesConfig.Builder	additionalSlaveSecurityGroups(String... additionalSlaveSecurityGroups) A list of additional Amazon EC2 security group IDs for the core and task nodes.
JobFlowInstancesConfig.Builder	ec2KeyName(String ec2KeyName) The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."
JobFlowInstancesConfig.Builder	ec2SubnetId(String ec2SubnetId) Applies to clusters that use the uniform instance group configuration.
JobFlowInstancesConfig.Builder	ec2SubnetIds(Collection<String> ec2SubnetIds) Applies to clusters that use the instance fleet configuration.
JobFlowInstancesConfig.Builder	ec2SubnetIds(String... ec2SubnetIds) Applies to clusters that use the instance fleet configuration.
JobFlowInstancesConfig.Builder	emrManagedMasterSecurityGroup(String emrManagedMasterSecurityGroup) The identifier of the Amazon EC2 security group for the master node.
JobFlowInstancesConfig.Builder	emrManagedSlaveSecurityGroup(String emrManagedSlaveSecurityGroup) The identifier of the Amazon EC2 security group for the core and task nodes.
JobFlowInstancesConfig.Builder	hadoopVersion(String hadoopVersion) Applies only to Amazon EMR release versions earlier than 4.0.
JobFlowInstancesConfig.Builder	instanceCount(Integer instanceCount) The number of EC2 instances in the cluster.
JobFlowInstancesConfig.Builder	instanceFleets(Collection<InstanceFleetConfig> instanceFleets)
JobFlowInstancesConfig.Builder	instanceFleets(Consumer<InstanceFleetConfig.Builder>... instanceFleets)
JobFlowInstancesConfig.Builder	instanceFleets(InstanceFleetConfig... instanceFleets)
JobFlowInstancesConfig.Builder	instanceGroups(Collection<InstanceGroupConfig> instanceGroups) Configuration for the instance groups in a cluster.
JobFlowInstancesConfig.Builder	instanceGroups(Consumer<InstanceGroupConfig.Builder>... instanceGroups) Configuration for the instance groups in a cluster.
JobFlowInstancesConfig.Builder	instanceGroups(InstanceGroupConfig... instanceGroups) Configuration for the instance groups in a cluster.
JobFlowInstancesConfig.Builder	keepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps) Specifies whether the cluster should remain available after completing all steps.
JobFlowInstancesConfig.Builder	masterInstanceType(String masterInstanceType) The EC2 instance type of the master node.
default JobFlowInstancesConfig.Builder	placement(Consumer<PlacementType.Builder> placement) The Availability Zone in which the cluster runs.
JobFlowInstancesConfig.Builder	placement(PlacementType placement) The Availability Zone in which the cluster runs.
JobFlowInstancesConfig.Builder	serviceAccessSecurityGroup(String serviceAccessSecurityGroup) The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
JobFlowInstancesConfig.Builder	slaveInstanceType(String slaveInstanceType) The EC2 instance type of the core and task nodes.
JobFlowInstancesConfig.Builder	terminationProtected(Boolean terminationProtected) Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

masterInstanceType

JobFlowInstancesConfig.Builder masterInstanceType(String masterInstanceType)

The EC2 instance type of the master node.

Parameters:

masterInstanceType - The EC2 instance type of the master node.

Returns:

Returns a reference to this object so that method calls can be chained together.

slaveInstanceType

JobFlowInstancesConfig.Builder slaveInstanceType(String slaveInstanceType)

The EC2 instance type of the core and task nodes.

Parameters:

slaveInstanceType - The EC2 instance type of the core and task nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceCount

JobFlowInstancesConfig.Builder instanceCount(Integer instanceCount)

The number of EC2 instances in the cluster.

Parameters:

instanceCount - The number of EC2 instances in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroups

JobFlowInstancesConfig.Builder instanceGroups(Collection<InstanceGroupConfig> instanceGroups)

Configuration for the instance groups in a cluster.

Parameters:

instanceGroups - Configuration for the instance groups in a cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroups

JobFlowInstancesConfig.Builder instanceGroups(InstanceGroupConfig... instanceGroups)

Configuration for the instance groups in a cluster.

Parameters:

instanceGroups - Configuration for the instance groups in a cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroups

JobFlowInstancesConfig.Builder instanceGroups(Consumer<InstanceGroupConfig.Builder>... instanceGroups)

Configuration for the instance groups in a cluster.

This is a convenience method that creates an instance of the InstanceGroupConfig.Builder avoiding the need to create one manually via InstanceGroupConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceGroups(List).

Parameters:

instanceGroups - a consumer that will call methods on InstanceGroupConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#instanceGroups(java.util.Collection)

instanceFleets

JobFlowInstancesConfig.Builder instanceFleets(Collection<InstanceFleetConfig> instanceFleets)

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

Parameters:

instanceFleets -

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceFleets

JobFlowInstancesConfig.Builder instanceFleets(InstanceFleetConfig... instanceFleets)

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

Parameters:

instanceFleets -

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceFleets

JobFlowInstancesConfig.Builder instanceFleets(Consumer<InstanceFleetConfig.Builder>... instanceFleets)

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

This is a convenience method that creates an instance of the InstanceFleetConfig.Builder avoiding the need to create one manually via InstanceFleetConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceFleets(List).

Parameters:

instanceFleets - a consumer that will call methods on InstanceFleetConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#instanceFleets(java.util.Collection)

ec2KeyName

JobFlowInstancesConfig.Builder ec2KeyName(String ec2KeyName)

The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."

Parameters:

ec2KeyName - The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."

Returns:

Returns a reference to this object so that method calls can be chained together.

placement

JobFlowInstancesConfig.Builder placement(PlacementType placement)

The Availability Zone in which the cluster runs.

Parameters:

placement - The Availability Zone in which the cluster runs.

Returns:

Returns a reference to this object so that method calls can be chained together.

placement

default JobFlowInstancesConfig.Builder placement(Consumer<PlacementType.Builder> placement)

The Availability Zone in which the cluster runs.

This is a convenience method that creates an instance of the PlacementType.Builder avoiding the need to create one manually via PlacementType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placement(PlacementType).

Parameters:

placement - a consumer that will call methods on PlacementType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

placement(PlacementType)

keepJobFlowAliveWhenNoSteps

JobFlowInstancesConfig.Builder keepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)

Specifies whether the cluster should remain available after completing all steps. Defaults to true. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.

Parameters:

keepJobFlowAliveWhenNoSteps - Specifies whether the cluster should remain available after completing all steps. Defaults to true. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

terminationProtected

JobFlowInstancesConfig.Builder terminationProtected(Boolean terminationProtected)

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

Parameters:

terminationProtected - Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

Returns:

Returns a reference to this object so that method calls can be chained together.

hadoopVersion

JobFlowInstancesConfig.Builder hadoopVersion(String hadoopVersion)

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

Parameters:

hadoopVersion - Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

ec2SubnetId

JobFlowInstancesConfig.Builder ec2SubnetId(String ec2SubnetId)

Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

Parameters:

ec2SubnetId - Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

Returns:

Returns a reference to this object so that method calls can be chained together.

ec2SubnetIds

JobFlowInstancesConfig.Builder ec2SubnetIds(Collection<String> ec2SubnetIds)

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Parameters:

ec2SubnetIds - Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Returns:

Returns a reference to this object so that method calls can be chained together.

ec2SubnetIds

JobFlowInstancesConfig.Builder ec2SubnetIds(String... ec2SubnetIds)

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Parameters:

ec2SubnetIds - Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Returns:

Returns a reference to this object so that method calls can be chained together.

emrManagedMasterSecurityGroup

JobFlowInstancesConfig.Builder emrManagedMasterSecurityGroup(String emrManagedMasterSecurityGroup)

The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.

Parameters:

emrManagedMasterSecurityGroup - The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

emrManagedSlaveSecurityGroup

JobFlowInstancesConfig.Builder emrManagedSlaveSecurityGroup(String emrManagedSlaveSecurityGroup)

The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.

Parameters:

emrManagedSlaveSecurityGroup - The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

serviceAccessSecurityGroup

JobFlowInstancesConfig.Builder serviceAccessSecurityGroup(String serviceAccessSecurityGroup)

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

Parameters:

serviceAccessSecurityGroup - The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMasterSecurityGroups

JobFlowInstancesConfig.Builder additionalMasterSecurityGroups(Collection<String> additionalMasterSecurityGroups)

A list of additional Amazon EC2 security group IDs for the master node.

Parameters:

additionalMasterSecurityGroups - A list of additional Amazon EC2 security group IDs for the master node.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMasterSecurityGroups

JobFlowInstancesConfig.Builder additionalMasterSecurityGroups(String... additionalMasterSecurityGroups)

A list of additional Amazon EC2 security group IDs for the master node.

Parameters:

additionalMasterSecurityGroups - A list of additional Amazon EC2 security group IDs for the master node.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalSlaveSecurityGroups

JobFlowInstancesConfig.Builder additionalSlaveSecurityGroups(Collection<String> additionalSlaveSecurityGroups)

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Parameters:

additionalSlaveSecurityGroups - A list of additional Amazon EC2 security group IDs for the core and task nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalSlaveSecurityGroups

JobFlowInstancesConfig.Builder additionalSlaveSecurityGroups(String... additionalSlaveSecurityGroups)

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Parameters:

additionalSlaveSecurityGroups - A list of additional Amazon EC2 security group IDs for the core and task nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.