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

Class Cluster

java.lang.Object

software.amazon.awssdk.services.emr.model.Cluster

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

@Generated("software.amazon.awssdk:codegen")
public class Cluster
extends Object
implements StructuredPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

The detailed description of the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Cluster.Builder

Method Summary

Modifier and Type	Method	Description
List<Application>	applications()	The applications installed on this cluster.
String	autoScalingRole()	An IAM role for automatic scaling policies.
Boolean	autoTerminate()	Specifies whether the cluster should terminate after completing all steps.
static Cluster.Builder	builder()
List<Configuration>	configurations()
Ec2InstanceAttributes	ec2InstanceAttributes()	Provides information about the EC2 instances in a cluster grouped by category.
boolean	equals(Object obj)
int	hashCode()
String	id()	The unique identifier for the cluster.
String	instanceCollectionType()
String	logUri()	The path to the Amazon S3 location where logs for this cluster are stored.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	masterPublicDnsName()	The public DNS name of the master EC2 instance.
String	name()	The name of the cluster.
Integer	normalizedInstanceHours()	An approximation of the cost of the cluster, represented in m1.small/hours.
String	releaseLabel()	The release label for the Amazon EMR release.
String	requestedAmiVersion()	The AMI version requested for this cluster.
String	runningAmiVersion()	The AMI version running on this cluster.
String	scaleDownBehavior()	The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
String	securityConfiguration()	The name of the security configuration applied to the cluster.
static Class<? extends Cluster.Builder>	serializableBuilderClass()
String	serviceRole()	The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
ClusterStatus	status()	The current status details about the cluster.
List<Tag>	tags()	A list of tags associated with a cluster.
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	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	visibleToAllUsers()	Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

id

public String id()

The unique identifier for the cluster.

Returns:

The unique identifier for the cluster.

name

public String name()

The name of the cluster.

Returns:

The name of the cluster.

status

public ClusterStatus status()

The current status details about the cluster.

Returns:

The current status details about the cluster.

ec2InstanceAttributes

public 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.

Returns:

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

instanceCollectionType

public 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.

Returns:

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.

See Also:

InstanceCollectionType

logUri

public String logUri()

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

Returns:

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

requestedAmiVersion

public String requestedAmiVersion()

The AMI version requested for this cluster.

Returns:

The AMI version requested for this cluster.

runningAmiVersion

public String runningAmiVersion()

The AMI version running on this cluster.

Returns:

The AMI version running on this cluster.

releaseLabel

public 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.

Returns:

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

autoTerminate

public Boolean autoTerminate()

Specifies whether the cluster should terminate after completing all steps.

Returns:

Specifies whether the cluster should terminate after completing all steps.

terminationProtected

public 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.

Returns:

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.

visibleToAllUsers

public 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.

Returns:

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.

applications

public List<Application> applications()

The applications installed on this cluster.

Returns:

The applications installed on this cluster.

tags

public List<Tag> tags()

A list of tags associated with a cluster.

Returns:

A list of tags associated with a cluster.

serviceRole

public String serviceRole()

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

Returns:

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

normalizedInstanceHours

public 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.

Returns:

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.

masterPublicDnsName

public String masterPublicDnsName()

The public DNS name of the master EC2 instance.

Returns:

The public DNS name of the master EC2 instance.

configurations

public List<Configuration> configurations()

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

Returns:

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

securityConfiguration

public String securityConfiguration()

The name of the security configuration applied to the cluster.

Returns:

The name of the security configuration applied to the cluster.

autoScalingRole

public 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.

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 EC2 instances in an instance group.

scaleDownBehavior

public 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.

Returns:

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.

See Also:

ScaleDownBehavior

toBuilder

public Cluster.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>

Returns:

a builder for type T

builder

public static Cluster.Builder builder()

serializableBuilderClass

public static Class<? extends Cluster.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.