@Generated(value="software.amazon.awssdk:codegen") public class Cluster extends Object implements StructuredPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
The detailed description of the cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
Cluster.Builder |
Modifier and Type | Method and 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()
Applies only to Amazon EMR releases 4.x and later.
|
String |
customAmiId()
Available only in Amazon EMR version 5.7.0 and later.
|
Integer |
ebsRootVolumeSize()
The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
|
Ec2InstanceAttributes |
ec2InstanceAttributes()
Provides information about the EC2 instances in a cluster grouped by category.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
id()
The unique identifier for the cluster.
|
InstanceCollectionType |
instanceCollectionType()
|
String |
instanceCollectionTypeString()
|
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.
|
RepoUpgradeOnBoot |
repoUpgradeOnBoot()
Applies only when
CustomAmiID is used. |
String |
repoUpgradeOnBootString()
Applies only when
CustomAmiID is used. |
String |
requestedAmiVersion()
The AMI version requested for this cluster.
|
String |
runningAmiVersion()
The AMI version running on this cluster.
|
ScaleDownBehavior |
scaleDownBehavior()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized.
|
String |
scaleDownBehaviorString()
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.
|
copy
public String id()
The unique identifier for the cluster.
public String name()
The name of the cluster.
public ClusterStatus status()
The current status details about the cluster.
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.
public 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.
If the service returns an enum value that is not available in the current SDK version,
instanceCollectionType
will return InstanceCollectionType.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from instanceCollectionTypeString()
.
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.
InstanceCollectionType
public String instanceCollectionTypeString()
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.
If the service returns an enum value that is not available in the current SDK version,
instanceCollectionType
will return InstanceCollectionType.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from instanceCollectionTypeString()
.
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.
InstanceCollectionType
public String logUri()
The path to the Amazon S3 location where logs for this cluster are stored.
public String requestedAmiVersion()
The AMI version requested for this cluster.
public String runningAmiVersion()
The AMI version running on this cluster.
public String releaseLabel()
The release label for the Amazon EMR release.
public Boolean autoTerminate()
Specifies whether the cluster should terminate after completing all steps.
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.
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.
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.public List<Application> applications()
The applications installed on this cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Tag> tags()
A list of tags associated with a cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String serviceRole()
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
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.
public String masterPublicDnsName()
The public DNS name of the master EC2 instance.
public List<Configuration> configurations()
Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String securityConfiguration()
The name of the security configuration applied to the cluster.
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.
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 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.
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 scaleDownBehaviorString()
.
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.ScaleDownBehavior
public String scaleDownBehaviorString()
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.
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 scaleDownBehaviorString()
.
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.ScaleDownBehavior
public String customAmiId()
Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
public Integer ebsRootVolumeSize()
The size, in GiB, of the 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 RepoUpgradeOnBoot repoUpgradeOnBoot()
Applies only when CustomAmiID
is used. Specifies the type of updates that are applied from the
Amazon Linux AMI package repositories when an instance boots using the AMI.
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 repoUpgradeOnBootString()
.
CustomAmiID
is used. Specifies the type of updates that are applied from
the Amazon Linux AMI package repositories when an instance boots using the AMI.RepoUpgradeOnBoot
public String repoUpgradeOnBootString()
Applies only when CustomAmiID
is used. Specifies the type of updates that are applied from the
Amazon Linux AMI package repositories when an instance boots using the AMI.
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 repoUpgradeOnBootString()
.
CustomAmiID
is used. Specifies the type of updates that are applied from
the Amazon Linux AMI package repositories when an instance boots using the AMI.RepoUpgradeOnBoot
public Cluster.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Cluster.Builder,Cluster>
public static Cluster.Builder builder()
public static Class<? extends Cluster.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.