Package software.amazon.awssdk.services.emr.model

Interface Cluster.Builder

All Superinterfaces:

CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>

Enclosing class:

Cluster

public static interface Cluster.Builder
extends CopyableBuilder<Cluster.Builder,Cluster>

Method Summary

Modifier and Type	Method	Description
Cluster.Builder	applications(Collection<Application> applications)	The applications installed on this cluster.
Cluster.Builder	applications(Application... applications)	The applications installed on this cluster.
Cluster.Builder	autoScalingRole(String autoScalingRole)	An IAM role for automatic scaling policies.
Cluster.Builder	autoTerminate(Boolean autoTerminate)	Specifies whether the cluster should terminate after completing all steps.
Cluster.Builder	configurations(Collection<Configuration> configurations)
Cluster.Builder	configurations(Configuration... configurations)
Cluster.Builder	ec2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)	Provides information about the EC2 instances in a cluster grouped by category.
Cluster.Builder	id(String id)	The unique identifier for the cluster.
Cluster.Builder	instanceCollectionType(String instanceCollectionType)
Cluster.Builder	instanceCollectionType(InstanceCollectionType instanceCollectionType)
Cluster.Builder	logUri(String logUri)	The path to the Amazon S3 location where logs for this cluster are stored.
Cluster.Builder	masterPublicDnsName(String masterPublicDnsName)	The public DNS name of the master EC2 instance.
Cluster.Builder	name(String name)	The name of the cluster.
Cluster.Builder	normalizedInstanceHours(Integer normalizedInstanceHours)	An approximation of the cost of the cluster, represented in m1.small/hours.
Cluster.Builder	releaseLabel(String releaseLabel)	The release label for the Amazon EMR release.
Cluster.Builder	requestedAmiVersion(String requestedAmiVersion)	The AMI version requested for this cluster.
Cluster.Builder	runningAmiVersion(String runningAmiVersion)	The AMI version running on this cluster.
Cluster.Builder	scaleDownBehavior(String scaleDownBehavior)	The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
Cluster.Builder	scaleDownBehavior(ScaleDownBehavior scaleDownBehavior)	The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
Cluster.Builder	securityConfiguration(String securityConfiguration)	The name of the security configuration applied to the cluster.
Cluster.Builder	serviceRole(String serviceRole)	The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
Cluster.Builder	status(ClusterStatus status)	The current status details about the cluster.
Cluster.Builder	tags(Collection<Tag> tags)	A list of tags associated with a cluster.
Cluster.Builder	tags(Tag... tags)	A list of tags associated with a cluster.
Cluster.Builder	terminationProtected(Boolean terminationProtected)	Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
Cluster.Builder	visibleToAllUsers(Boolean visibleToAllUsers)	Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

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

copy

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

apply, build

Method Detail

id

Cluster.Builder id(String id)

The unique identifier for the cluster.

Parameters:

id - The unique identifier for the cluster.

Returns:

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

name

Cluster.Builder name(String name)

The name of the cluster.

Parameters:

name - The name of the cluster.

Returns:

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

status

Cluster.Builder status(ClusterStatus status)

The current status details about the cluster.

Parameters:

status - The current status details about the cluster.

Returns:

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

ec2InstanceAttributes

Cluster.Builder ec2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

Parameters:

ec2InstanceAttributes - Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

Returns:

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

instanceCollectionType

Cluster.Builder instanceCollectionType(String instanceCollectionType)

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

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Parameters:

instanceCollectionType -

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

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Returns:

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

See Also:

InstanceCollectionType

instanceCollectionType

Cluster.Builder instanceCollectionType(InstanceCollectionType instanceCollectionType)

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

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Parameters:

instanceCollectionType -

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

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Returns:

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

See Also:

InstanceCollectionType

logUri

Cluster.Builder logUri(String logUri)

The path to the Amazon S3 location where logs for this cluster are stored.

Parameters:

logUri - The path to the Amazon S3 location where logs for this cluster are stored.

Returns:

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

requestedAmiVersion

Cluster.Builder requestedAmiVersion(String requestedAmiVersion)

The AMI version requested for this cluster.

Parameters:

requestedAmiVersion - The AMI version requested for this cluster.

Returns:

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

runningAmiVersion

Cluster.Builder runningAmiVersion(String runningAmiVersion)

The AMI version running on this cluster.

Parameters:

runningAmiVersion - The AMI version running on this cluster.

Returns:

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

releaseLabel

Cluster.Builder releaseLabel(String releaseLabel)

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

Parameters:

releaseLabel - The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

Returns:

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

autoTerminate

Cluster.Builder autoTerminate(Boolean autoTerminate)

Specifies whether the cluster should terminate after completing all steps.

Parameters:

autoTerminate - Specifies whether the cluster should terminate after completing all steps.

Returns:

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

terminationProtected

Cluster.Builder terminationProtected(Boolean terminationProtected)

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Parameters:

terminationProtected - Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Returns:

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

visibleToAllUsers

Cluster.Builder visibleToAllUsers(Boolean visibleToAllUsers)

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Parameters:

visibleToAllUsers - Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Returns:

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

applications

Cluster.Builder applications(Collection<Application> applications)

The applications installed on this cluster.

Parameters:

applications - The applications installed on this cluster.

Returns:

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

applications

Cluster.Builder applications(Application... applications)

The applications installed on this cluster.

NOTE: This method appends the values to the existing list (if any). Use #setApplications(java.util.Collection) or #withApplications(java.util.Collection) if you want to override the existing values.

Parameters:

applications - The applications installed on this cluster.

Returns:

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

tags

Cluster.Builder tags(Collection<Tag> tags)

A list of tags associated with a cluster.

Parameters:

tags - A list of tags associated with a cluster.

Returns:

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

tags

Cluster.Builder tags(Tag... tags)

A list of tags associated with a cluster.

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of tags associated with a cluster.

Returns:

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

serviceRole

Cluster.Builder serviceRole(String serviceRole)

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Parameters:

serviceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Returns:

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

normalizedInstanceHours

Cluster.Builder normalizedInstanceHours(Integer normalizedInstanceHours)

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Parameters:

normalizedInstanceHours - An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Returns:

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

masterPublicDnsName

Cluster.Builder masterPublicDnsName(String masterPublicDnsName)

The public DNS name of the master EC2 instance.

Parameters:

masterPublicDnsName - The public DNS name of the master EC2 instance.

Returns:

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

configurations

Cluster.Builder configurations(Collection<Configuration> configurations)

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

Parameters:

configurations -

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

Returns:

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

configurations

Cluster.Builder configurations(Configuration... configurations)

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

NOTE: This method appends the values to the existing list (if any). Use #setConfigurations(java.util.Collection) or #withConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

configurations -

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

Returns:

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

securityConfiguration

Cluster.Builder securityConfiguration(String securityConfiguration)

The name of the security configuration applied to the cluster.

Parameters:

securityConfiguration - The name of the security configuration applied to the cluster.

Returns:

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

autoScalingRole

Cluster.Builder autoScalingRole(String autoScalingRole)

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Parameters:

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.

Returns:

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

scaleDownBehavior

Cluster.Builder scaleDownBehavior(String scaleDownBehavior)

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 blacklists 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 is 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.

Parameters:

scaleDownBehavior - 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 blacklists 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 is 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.

Returns:

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

See Also:

ScaleDownBehavior

scaleDownBehavior

Cluster.Builder scaleDownBehavior(ScaleDownBehavior scaleDownBehavior)

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 blacklists 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 is 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.

Parameters:

scaleDownBehavior - 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 blacklists 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 is 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.

Returns:

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

See Also:

ScaleDownBehavior