java.lang.Object
com.amazonaws.services.elasticmapreduce.model.Cluster
All Implemented Interfaces:
Serializable, Cloneable

public class Cluster extends Object implements Serializable, Cloneable

The detailed description of the cluster.

See Also:
  • Constructor Details

    • Cluster

      public Cluster()
  • Method Details

    • setId

      public void setId(String id)

      The unique identifier for the cluster.

      Parameters:
      id - The unique identifier for the cluster.
    • getId

      public String getId()

      The unique identifier for the cluster.

      Returns:
      The unique identifier for the cluster.
    • withId

      public Cluster withId(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.
    • setName

      public void setName(String name)

      The name of the cluster.

      Parameters:
      name - The name of the cluster.
    • getName

      public String getName()

      The name of the cluster.

      Returns:
      The name of the cluster.
    • withName

      public Cluster withName(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.
    • setStatus

      public void setStatus(ClusterStatus status)

      The current status details about the cluster.

      Parameters:
      status - The current status details about the cluster.
    • getStatus

      public ClusterStatus getStatus()

      The current status details about the cluster.

      Returns:
      The current status details about the cluster.
    • withStatus

      public Cluster withStatus(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.
    • setEc2InstanceAttributes

      public void setEc2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)
      Parameters:
      ec2InstanceAttributes -
    • getEc2InstanceAttributes

      public Ec2InstanceAttributes getEc2InstanceAttributes()
      Returns:
    • withEc2InstanceAttributes

      public Cluster withEc2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)
      Parameters:
      ec2InstanceAttributes -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLogUri

      public void setLogUri(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.
    • getLogUri

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

      public Cluster withLogUri(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.
    • setRequestedAmiVersion

      public void setRequestedAmiVersion(String requestedAmiVersion)

      The AMI version requested for this cluster.

      Parameters:
      requestedAmiVersion - The AMI version requested for this cluster.
    • getRequestedAmiVersion

      public String getRequestedAmiVersion()

      The AMI version requested for this cluster.

      Returns:
      The AMI version requested for this cluster.
    • withRequestedAmiVersion

      public Cluster withRequestedAmiVersion(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.
    • setRunningAmiVersion

      public void setRunningAmiVersion(String runningAmiVersion)

      The AMI version running on this cluster.

      Parameters:
      runningAmiVersion - The AMI version running on this cluster.
    • getRunningAmiVersion

      public String getRunningAmiVersion()

      The AMI version running on this cluster.

      Returns:
      The AMI version running on this cluster.
    • withRunningAmiVersion

      public Cluster withRunningAmiVersion(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.
    • setReleaseLabel

      public void setReleaseLabel(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.
    • getReleaseLabel

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

      public Cluster withReleaseLabel(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.
    • setAutoTerminate

      public void setAutoTerminate(Boolean autoTerminate)

      Specifies whether the cluster should terminate after completing all steps.

      Parameters:
      autoTerminate - Specifies whether the cluster should terminate after completing all steps.
    • getAutoTerminate

      public Boolean getAutoTerminate()

      Specifies whether the cluster should terminate after completing all steps.

      Returns:
      Specifies whether the cluster should terminate after completing all steps.
    • withAutoTerminate

      public Cluster withAutoTerminate(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.
    • isAutoTerminate

      public Boolean isAutoTerminate()

      Specifies whether the cluster should terminate after completing all steps.

      Returns:
      Specifies whether the cluster should terminate after completing all steps.
    • setTerminationProtected

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

      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

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

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

      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

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

      public void setVisibleToAllUsers(Boolean 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 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 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 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 is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
    • getVisibleToAllUsers

      public Boolean 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 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 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 is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
    • withVisibleToAllUsers

      public Cluster withVisibleToAllUsers(Boolean 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 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 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 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 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.
    • isVisibleToAllUsers

      public Boolean 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 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 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 is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
    • getApplications

      public List<Application> getApplications()

      The applications installed on this cluster.

      Returns:
      The applications installed on this cluster.
    • setApplications

      public void setApplications(Collection<Application> applications)

      The applications installed on this cluster.

      Parameters:
      applications - The applications installed on this cluster.
    • withApplications

      public Cluster withApplications(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.
    • withApplications

      public Cluster withApplications(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.
    • getTags

      public List<Tag> getTags()

      A list of tags associated with a cluster.

      Returns:
      A list of tags associated with a cluster.
    • setTags

      public void setTags(Collection<Tag> tags)

      A list of tags associated with a cluster.

      Parameters:
      tags - A list of tags associated with a cluster.
    • withTags

      public Cluster withTags(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.
    • withTags

      public Cluster withTags(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.
    • setServiceRole

      public void setServiceRole(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.
    • getServiceRole

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

      public Cluster withServiceRole(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.
    • setNormalizedInstanceHours

      public void setNormalizedInstanceHours(Integer 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.

      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

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

      public Cluster withNormalizedInstanceHours(Integer 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.

      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

      public void setMasterPublicDnsName(String masterPublicDnsName)

      The public DNS name of the master EC2 instance.

      Parameters:
      masterPublicDnsName - The public DNS name of the master EC2 instance.
    • getMasterPublicDnsName

      public String getMasterPublicDnsName()

      The public DNS name of the master EC2 instance.

      Returns:
      The public DNS name of the master EC2 instance.
    • withMasterPublicDnsName

      public Cluster withMasterPublicDnsName(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.
    • getConfigurations

      public List<Configuration> 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

      public void setConfigurations(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.

    • withConfigurations

      public Cluster withConfigurations(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.

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

      public Cluster withConfigurations(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.

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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public Cluster clone()
      Overrides:
      clone in class Object