Class Cluster
- All Implemented Interfaces:
Serializable
,Cloneable
The detailed description of the cluster.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The applications installed on this cluster.Specifies whether the cluster should terminate after completing all steps.getId()
The unique identifier for the cluster.The path to the Amazon S3 location where logs for this cluster are stored.The public DNS name of the master EC2 instance.getName()
The name of the cluster.An approximation of the cost of the job flow, represented in m1.small/hours.The release label for the Amazon EMR release.The AMI version requested for this cluster.The AMI version running on this cluster.The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.The current status details about the cluster.getTags()
A list of tags associated with a cluster.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.Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow.int
hashCode()
Specifies whether the cluster should terminate after completing all steps.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.Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow.void
setApplications
(Collection<Application> applications) The applications installed on this cluster.void
setAutoTerminate
(Boolean autoTerminate) Specifies whether the cluster should terminate after completing all steps.void
setConfigurations
(Collection<Configuration> configurations) void
setEc2InstanceAttributes
(Ec2InstanceAttributes ec2InstanceAttributes) void
The unique identifier for the cluster.void
The path to the Amazon S3 location where logs for this cluster are stored.void
setMasterPublicDnsName
(String masterPublicDnsName) The public DNS name of the master EC2 instance.void
The name of the cluster.void
setNormalizedInstanceHours
(Integer normalizedInstanceHours) An approximation of the cost of the job flow, represented in m1.small/hours.void
setReleaseLabel
(String releaseLabel) The release label for the Amazon EMR release.void
setRequestedAmiVersion
(String requestedAmiVersion) The AMI version requested for this cluster.void
setRunningAmiVersion
(String runningAmiVersion) The AMI version running on this cluster.void
setServiceRole
(String serviceRole) The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.void
setStatus
(ClusterStatus status) The current status details about the cluster.void
setTags
(Collection<Tag> tags) A list of tags associated with a cluster.void
setTerminationProtected
(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.void
setVisibleToAllUsers
(Boolean visibleToAllUsers) Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow.toString()
Returns a string representation of this object; useful for testing and debugging.withApplications
(Application... applications) The applications installed on this cluster.withApplications
(Collection<Application> applications) The applications installed on this cluster.withAutoTerminate
(Boolean autoTerminate) Specifies whether the cluster should terminate after completing all steps.withConfigurations
(Configuration... configurations) withConfigurations
(Collection<Configuration> configurations) withEc2InstanceAttributes
(Ec2InstanceAttributes ec2InstanceAttributes) The unique identifier for the cluster.withLogUri
(String logUri) The path to the Amazon S3 location where logs for this cluster are stored.withMasterPublicDnsName
(String masterPublicDnsName) The public DNS name of the master EC2 instance.The name of the cluster.withNormalizedInstanceHours
(Integer normalizedInstanceHours) An approximation of the cost of the job flow, represented in m1.small/hours.withReleaseLabel
(String releaseLabel) The release label for the Amazon EMR release.withRequestedAmiVersion
(String requestedAmiVersion) The AMI version requested for this cluster.withRunningAmiVersion
(String runningAmiVersion) The AMI version running on this cluster.withServiceRole
(String serviceRole) The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.withStatus
(ClusterStatus status) The current status details about the cluster.A list of tags associated with a cluster.withTags
(Collection<Tag> tags) A list of tags associated with a cluster.withTerminationProtected
(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.withVisibleToAllUsers
(Boolean visibleToAllUsers) Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow.
-
Constructor Details
-
Cluster
public Cluster()
-
-
Method Details
-
setId
The unique identifier for the cluster.
- Parameters:
id
- The unique identifier for the cluster.
-
getId
The unique identifier for the cluster.
- Returns:
- The unique identifier for the cluster.
-
withId
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.
-
setName
The name of the cluster.
- Parameters:
name
- The name of the cluster.
-
getName
The name of the cluster.
- Returns:
- The name of the cluster.
-
withName
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.
-
setStatus
The current status details about the cluster.
- Parameters:
status
- The current status details about the cluster.
-
getStatus
The current status details about the cluster.
- Returns:
- The current status details about the cluster.
-
withStatus
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.
-
setEc2InstanceAttributes
- Parameters:
ec2InstanceAttributes
-
-
getEc2InstanceAttributes
- Returns:
-
withEc2InstanceAttributes
- Parameters:
ec2InstanceAttributes
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLogUri
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.
-
getLogUri
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.
-
withLogUri
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.
-
setRequestedAmiVersion
The AMI version requested for this cluster.
- Parameters:
requestedAmiVersion
- The AMI version requested for this cluster.
-
getRequestedAmiVersion
The AMI version requested for this cluster.
- Returns:
- The AMI version requested for this cluster.
-
withRequestedAmiVersion
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.
-
setRunningAmiVersion
The AMI version running on this cluster.
- Parameters:
runningAmiVersion
- The AMI version running on this cluster.
-
getRunningAmiVersion
The AMI version running on this cluster.
- Returns:
- The AMI version running on this cluster.
-
withRunningAmiVersion
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.
-
setReleaseLabel
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.
-
getReleaseLabel
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.
-
withReleaseLabel
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.
-
setAutoTerminate
Specifies whether the cluster should terminate after completing all steps.
- Parameters:
autoTerminate
- Specifies whether the cluster should terminate after completing all steps.
-
getAutoTerminate
Specifies whether the cluster should terminate after completing all steps.
- Returns:
- Specifies whether the cluster should terminate after completing all steps.
-
withAutoTerminate
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.
-
isAutoTerminate
Specifies whether the cluster should terminate after completing all steps.
- Returns:
- Specifies whether the cluster should terminate after completing all steps.
-
setTerminationProtected
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.
-
getTerminationProtected
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.
-
withTerminationProtected
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.
-
isTerminationProtected
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.
-
setVisibleToAllUsers
Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to
true
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, 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 job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set totrue
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
-
getVisibleToAllUsers
Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to
true
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, 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 job flow is visible to all IAM users of the
AWS account associated with the job flow. If this value is set to
true
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
-
withVisibleToAllUsers
Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to
true
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, 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 job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set totrue
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, 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.
-
isVisibleToAllUsers
Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to
true
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, 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 job flow is visible to all IAM users of the
AWS account associated with the job flow. If this value is set to
true
, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value isfalse
, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
-
getApplications
The applications installed on this cluster.
- Returns:
- The applications installed on this cluster.
-
setApplications
The applications installed on this cluster.
- Parameters:
applications
- The applications installed on this cluster.
-
withApplications
The applications installed on this cluster.
NOTE: This method appends the values to the existing list (if any). Use
setApplications(java.util.Collection)
orwithApplications(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.
-
withApplications
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.
-
getTags
A list of tags associated with a cluster.
- Returns:
- A list of tags associated with a cluster.
-
setTags
A list of tags associated with a cluster.
- Parameters:
tags
- A list of tags associated with a cluster.
-
withTags
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)
orwithTags(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.
-
withTags
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.
-
setServiceRole
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.
-
getServiceRole
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.
-
withServiceRole
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.
-
setNormalizedInstanceHours
An approximation of the cost of the job flow, 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 job flow, 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.
-
getNormalizedInstanceHours
An approximation of the cost of the job flow, 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 job flow, 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.
-
withNormalizedInstanceHours
An approximation of the cost of the job flow, 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 job flow, 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.
-
setMasterPublicDnsName
The public DNS name of the master EC2 instance.
- Parameters:
masterPublicDnsName
- The public DNS name of the master EC2 instance.
-
getMasterPublicDnsName
The public DNS name of the master EC2 instance.
- Returns:
- The public DNS name of the master EC2 instance.
-
withMasterPublicDnsName
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.
-
getConfigurations
Amazon EMR releases 4.x or later.
The list of Configurations supplied to the EMR cluster.
- Returns:
- Amazon EMR releases 4.x or later.
-
setConfigurations
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.
-
withConfigurations
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)
orwithConfigurations(java.util.Collection)
if you want to override the existing values.- Parameters:
configurations
- Amazon EMR releases 4.x or later.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withConfigurations
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-