Cluster (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticmapreduce.model.Cluster

All Implemented Interfaces:

Serializable
```
public class Cluster
extends Object
implements Serializable
```
The detailed description of the cluster.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cluster()

Constructors
Constructor and Description
`Cluster()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<Application>`	`getApplications()` The applications installed on this cluster.
`Boolean`	`getAutoTerminate()` Specifies whether the cluster should terminate after completing all steps.
`Ec2InstanceAttributes`	`getEc2InstanceAttributes()` Provides information about the EC2 instances in a cluster grouped by category.
`String`	`getId()` The unique identifier for the cluster.
`String`	`getLogUri()` The path to the Amazon S3 location where logs for this cluster are stored.
`String`	`getName()` The name of the cluster.
`String`	`getRequestedAmiVersion()` The AMI version requested for this cluster.
`String`	`getRunningAmiVersion()` The AMI version running on this cluster.
`ClusterStatus`	`getStatus()` The current status details about the cluster.
`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.
`Boolean`	`getVisibleToAllUsers()` Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow.
`int`	`hashCode()`
`Boolean`	`isAutoTerminate()` Specifies whether the cluster should terminate after completing all steps.
`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.
`Boolean`	`isVisibleToAllUsers()` 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`	`setEc2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)` Provides information about the EC2 instances in a cluster grouped by category.
`void`	`setId(String id)` The unique identifier for the cluster.
`void`	`setLogUri(String logUri)` The path to the Amazon S3 location where logs for this cluster are stored.
`void`	`setName(String name)` The name of the cluster.
`void`	`setRequestedAmiVersion(String requestedAmiVersion)` The AMI version requested for this cluster.
`void`	`setRunningAmiVersion(String runningAmiVersion)` The AMI version running on this cluster.
`void`	`setStatus(ClusterStatus status)` The current status details about the 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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Cluster`	`withApplications(Application... applications)` The applications installed on this cluster.
`Cluster`	`withApplications(Collection<Application> applications)` The applications installed on this cluster.
`Cluster`	`withAutoTerminate(Boolean autoTerminate)` Specifies whether the cluster should terminate after completing all steps.
`Cluster`	`withEc2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)` Provides information about the EC2 instances in a cluster grouped by category.
`Cluster`	`withId(String id)` The unique identifier for the cluster.
`Cluster`	`withLogUri(String logUri)` The path to the Amazon S3 location where logs for this cluster are stored.
`Cluster`	`withName(String name)` The name of the cluster.
`Cluster`	`withRequestedAmiVersion(String requestedAmiVersion)` The AMI version requested for this cluster.
`Cluster`	`withRunningAmiVersion(String runningAmiVersion)` The AMI version running on this cluster.
`Cluster`	`withStatus(ClusterStatus status)` The current status details about the cluster.
`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.
`Cluster`	`withVisibleToAllUsers(Boolean visibleToAllUsers)` Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Cluster
```
public Cluster()
```
- Method Detail
  - getId
```
public String getId()
```
    The unique identifier for the cluster.
    Constraints:
    Length: 1 - 64
    
    Returns:
    The unique identifier for the cluster.
  - setId
```
public void setId(String id)
```
    The unique identifier for the cluster.
    Constraints:
    Length: 1 - 64
    
    Parameters:
    id - The unique identifier for the cluster.
  - withId
```
public Cluster withId(String id)
```
    The unique identifier for the cluster.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    
    Parameters:
    id - The unique identifier for the cluster.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public String getName()
```
    The name of the cluster.
    Constraints:
    Length: 0 - 256
    
    Returns:
    The name of the cluster.
  - setName
```
public void setName(String name)
```
    The name of the cluster.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    name - The name of the cluster.
  - withName
```
public Cluster withName(String name)
```
    The name of the cluster.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    name - The name of the cluster.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getStatus
```
public ClusterStatus getStatus()
```
    The current status details about the cluster.
    
    Returns:
    The current status details about the cluster.
  - setStatus
```
public void setStatus(ClusterStatus status)
```
    The current status details about the cluster.
    
    Parameters:
    status - The current status details about the cluster.
  - withStatus
```
public Cluster withStatus(ClusterStatus status)
```
    The current status details about the cluster.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    status - The current status details about the cluster.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEc2InstanceAttributes
```
public Ec2InstanceAttributes getEc2InstanceAttributes()
```
    Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.
    
    Returns:
    Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.
  - setEc2InstanceAttributes
```
public void setEc2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)
```
    Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.
    
    Parameters:
    ec2InstanceAttributes - Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.
  - withEc2InstanceAttributes
```
public Cluster withEc2InstanceAttributes(Ec2InstanceAttributes ec2InstanceAttributes)
```
    Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    ec2InstanceAttributes - Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withLogUri
```
public Cluster withLogUri(String logUri)
```
    The path to the Amazon S3 location where logs for this cluster are stored.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    logUri - The path to the Amazon S3 location where logs for this cluster are stored.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRequestedAmiVersion
```
public String getRequestedAmiVersion()
```
    The AMI version requested for this cluster.
    Constraints:
    Length: 0 - 256
    
    Returns:
    The AMI version requested for this cluster.
  - setRequestedAmiVersion
```
public void setRequestedAmiVersion(String requestedAmiVersion)
```
    The AMI version requested for this cluster.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    requestedAmiVersion - The AMI version requested for this cluster.
  - withRequestedAmiVersion
```
public Cluster withRequestedAmiVersion(String requestedAmiVersion)
```
    The AMI version requested for this cluster.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    requestedAmiVersion - The AMI version requested for this cluster.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRunningAmiVersion
```
public String getRunningAmiVersion()
```
    The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest".
    Constraints:
    Length: 0 - 256
    
    Returns:
    The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest".
  - setRunningAmiVersion
```
public void setRunningAmiVersion(String runningAmiVersion)
```
    The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest".
    Constraints:
    Length: 0 - 256
    
    Parameters:
    runningAmiVersion - The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest".
  - withRunningAmiVersion
```
public Cluster withRunningAmiVersion(String runningAmiVersion)
```
    The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest".
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    runningAmiVersion - The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest".
    
    Returns:
    A reference to this updated 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.
  - 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.
  - withAutoTerminate
```
public Cluster withAutoTerminate(Boolean autoTerminate)
```
    Specifies whether the cluster should terminate after completing all steps.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    autoTerminate - Specifies whether the cluster should terminate after completing all steps.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    applications - The applications installed on this cluster.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withApplications
```
public Cluster withApplications(Collection<Application> applications)
```
    The applications installed on this cluster.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    applications - The applications installed on this cluster.
    
    Returns:
    A reference to this updated 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:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class Cluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cluster

Method Detail

getId

setId

withId

getName

setName

withName

getStatus

setStatus

withStatus

getEc2InstanceAttributes

setEc2InstanceAttributes

withEc2InstanceAttributes

getLogUri

setLogUri

withLogUri

getRequestedAmiVersion

setRequestedAmiVersion

withRequestedAmiVersion

getRunningAmiVersion

setRunningAmiVersion

withRunningAmiVersion

isAutoTerminate

setAutoTerminate

withAutoTerminate

getAutoTerminate

isTerminationProtected

setTerminationProtected

withTerminationProtected

getTerminationProtected

isVisibleToAllUsers

setVisibleToAllUsers

withVisibleToAllUsers

getVisibleToAllUsers

getApplications

setApplications

withApplications

withApplications

toString

hashCode

equals