Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.elasticmapreduce.model
Class JobFlowInstancesConfig

java.lang.Object
  extended by com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesConfig
All Implemented Interfaces:
Serializable
public class JobFlowInstancesConfig
extends Object
implements Serializable

A description of the Amazon EC2 instance running the job flow.

See Also:
Serialized Form

Constructor Summary
JobFlowInstancesConfig()
          Default constructor for a new JobFlowInstancesConfig object.
 
Method Summary
 boolean equals(Object obj)
           
 String getEc2KeyName()
          Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
 String getEc2SubnetId()
          To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch.
 String getHadoopVersion()
          Specifies the Hadoop version for the job flow.
 Integer getInstanceCount()
          The number of Amazon EC2 instances used to execute the job flow.
 List<InstanceGroupConfig> getInstanceGroups()
          Configuration for the job flow's instance groups.
 Boolean getKeepJobFlowAliveWhenNoSteps()
          Specifies whether the job flow should terminate after completing all steps.
 String getMasterInstanceType()
          The EC2 instance type of the master node.
 PlacementType getPlacement()
          Specifies the Availability Zone the job flow will run in.
 String getSlaveInstanceType()
          The EC2 instance type of the slave nodes.
 Boolean getTerminationProtected()
          Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
 int hashCode()
           
 Boolean isKeepJobFlowAliveWhenNoSteps()
          Specifies whether the job flow should terminate after completing all steps.
 Boolean isTerminationProtected()
          Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
 void setEc2KeyName(String ec2KeyName)
          Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
 void setEc2SubnetId(String ec2SubnetId)
          To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch.
 void setHadoopVersion(String hadoopVersion)
          Specifies the Hadoop version for the job flow.
 void setInstanceCount(Integer instanceCount)
          The number of Amazon EC2 instances used to execute the job flow.
 void setInstanceGroups(Collection<InstanceGroupConfig> instanceGroups)
          Configuration for the job flow's instance groups.
 void setKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)
          Specifies whether the job flow should terminate after completing all steps.
 void setMasterInstanceType(String masterInstanceType)
          The EC2 instance type of the master node.
 void setPlacement(PlacementType placement)
          Specifies the Availability Zone the job flow will run in.
 void setSlaveInstanceType(String slaveInstanceType)
          The EC2 instance type of the slave nodes.
 void setTerminationProtected(Boolean terminationProtected)
          Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 JobFlowInstancesConfig withEc2KeyName(String ec2KeyName)
          Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
 JobFlowInstancesConfig withEc2SubnetId(String ec2SubnetId)
          To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch.
 JobFlowInstancesConfig withHadoopVersion(String hadoopVersion)
          Specifies the Hadoop version for the job flow.
 JobFlowInstancesConfig withInstanceCount(Integer instanceCount)
          The number of Amazon EC2 instances used to execute the job flow.
 JobFlowInstancesConfig withInstanceGroups(Collection<InstanceGroupConfig> instanceGroups)
          Configuration for the job flow's instance groups.
 JobFlowInstancesConfig withInstanceGroups(InstanceGroupConfig... instanceGroups)
          Configuration for the job flow's instance groups.
 JobFlowInstancesConfig withKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)
          Specifies whether the job flow should terminate after completing all steps.
 JobFlowInstancesConfig withMasterInstanceType(String masterInstanceType)
          The EC2 instance type of the master node.
 JobFlowInstancesConfig withPlacement(PlacementType placement)
          Specifies the Availability Zone the job flow will run in.
 JobFlowInstancesConfig withSlaveInstanceType(String slaveInstanceType)
          The EC2 instance type of the slave nodes.
 JobFlowInstancesConfig withTerminationProtected(Boolean terminationProtected)
          Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobFlowInstancesConfig

public JobFlowInstancesConfig()
Default constructor for a new JobFlowInstancesConfig object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getMasterInstanceType

public String getMasterInstanceType()
The EC2 instance type of the master node.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Returns:
The EC2 instance type of the master node.

setMasterInstanceType

public void setMasterInstanceType(String masterInstanceType)
The EC2 instance type of the master node.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
masterInstanceType - The EC2 instance type of the master node.

withMasterInstanceType

public JobFlowInstancesConfig withMasterInstanceType(String masterInstanceType)
The EC2 instance type of the master node.

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

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
masterInstanceType - The EC2 instance type of the master node.
Returns:
A reference to this updated object so that method calls can be chained together.

getSlaveInstanceType

public String getSlaveInstanceType()
The EC2 instance type of the slave nodes.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Returns:
The EC2 instance type of the slave nodes.

setSlaveInstanceType

public void setSlaveInstanceType(String slaveInstanceType)
The EC2 instance type of the slave nodes.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
slaveInstanceType - The EC2 instance type of the slave nodes.

withSlaveInstanceType

public JobFlowInstancesConfig withSlaveInstanceType(String slaveInstanceType)
The EC2 instance type of the slave nodes.

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

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
slaveInstanceType - The EC2 instance type of the slave nodes.
Returns:
A reference to this updated object so that method calls can be chained together.

getInstanceCount

public Integer getInstanceCount()
The number of Amazon EC2 instances used to execute the job flow.

Returns:
The number of Amazon EC2 instances used to execute the job flow.

setInstanceCount

public void setInstanceCount(Integer instanceCount)
The number of Amazon EC2 instances used to execute the job flow.

Parameters:
instanceCount - The number of Amazon EC2 instances used to execute the job flow.

withInstanceCount

public JobFlowInstancesConfig withInstanceCount(Integer instanceCount)
The number of Amazon EC2 instances used to execute the job flow.

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

Parameters:
instanceCount - The number of Amazon EC2 instances used to execute the job flow.
Returns:
A reference to this updated object so that method calls can be chained together.

getInstanceGroups

public List<InstanceGroupConfig> getInstanceGroups()
Configuration for the job flow's instance groups.

Returns:
Configuration for the job flow's instance groups.

setInstanceGroups

public void setInstanceGroups(Collection<InstanceGroupConfig> instanceGroups)
Configuration for the job flow's instance groups.

Parameters:
instanceGroups - Configuration for the job flow's instance groups.

withInstanceGroups

public JobFlowInstancesConfig withInstanceGroups(InstanceGroupConfig... instanceGroups)
Configuration for the job flow's instance groups.

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

Parameters:
instanceGroups - Configuration for the job flow's instance groups.
Returns:
A reference to this updated object so that method calls can be chained together.

withInstanceGroups

public JobFlowInstancesConfig withInstanceGroups(Collection<InstanceGroupConfig> instanceGroups)
Configuration for the job flow's instance groups.

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

Parameters:
instanceGroups - Configuration for the job flow's instance groups.
Returns:
A reference to this updated object so that method calls can be chained together.

getEc2KeyName

public String getEc2KeyName()
Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Returns:
Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

setEc2KeyName

public void setEc2KeyName(String ec2KeyName)
Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
ec2KeyName - Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

withEc2KeyName

public JobFlowInstancesConfig withEc2KeyName(String ec2KeyName)
Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

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

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
ec2KeyName - Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
Returns:
A reference to this updated object so that method calls can be chained together.

getPlacement

public PlacementType getPlacement()
Specifies the Availability Zone the job flow will run in.

Returns:
Specifies the Availability Zone the job flow will run in.

setPlacement

public void setPlacement(PlacementType placement)
Specifies the Availability Zone the job flow will run in.

Parameters:
placement - Specifies the Availability Zone the job flow will run in.

withPlacement

public JobFlowInstancesConfig withPlacement(PlacementType placement)
Specifies the Availability Zone the job flow will run in.

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

Parameters:
placement - Specifies the Availability Zone the job flow will run in.
Returns:
A reference to this updated object so that method calls can be chained together.

isKeepJobFlowAliveWhenNoSteps

public Boolean isKeepJobFlowAliveWhenNoSteps()
Specifies whether the job flow should terminate after completing all steps.

Returns:
Specifies whether the job flow should terminate after completing all steps.

setKeepJobFlowAliveWhenNoSteps

public void setKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)
Specifies whether the job flow should terminate after completing all steps.

Parameters:
keepJobFlowAliveWhenNoSteps - Specifies whether the job flow should terminate after completing all steps.

withKeepJobFlowAliveWhenNoSteps

public JobFlowInstancesConfig withKeepJobFlowAliveWhenNoSteps(Boolean keepJobFlowAliveWhenNoSteps)
Specifies whether the job flow should terminate after completing all steps.

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

Parameters:
keepJobFlowAliveWhenNoSteps - Specifies whether the job flow should terminate after completing all steps.
Returns:
A reference to this updated object so that method calls can be chained together.

getKeepJobFlowAliveWhenNoSteps

public Boolean getKeepJobFlowAliveWhenNoSteps()
Specifies whether the job flow should terminate after completing all steps.

Returns:
Specifies whether the job flow should terminate after completing all steps.

isTerminationProtected

public Boolean isTerminationProtected()
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

Returns:
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

setTerminationProtected

public void setTerminationProtected(Boolean terminationProtected)
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

Parameters:
terminationProtected - Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

withTerminationProtected

public JobFlowInstancesConfig withTerminationProtected(Boolean terminationProtected)
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

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

Parameters:
terminationProtected - Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
Returns:
A reference to this updated object so that method calls can be chained together.

getTerminationProtected

public Boolean getTerminationProtected()
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

Returns:
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

getHadoopVersion

public String getHadoopVersion()
Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Returns:
Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

setHadoopVersion

public void setHadoopVersion(String hadoopVersion)
Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
hadoopVersion - Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

withHadoopVersion

public JobFlowInstancesConfig withHadoopVersion(String hadoopVersion)
Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

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

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
hadoopVersion - Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
Returns:
A reference to this updated object so that method calls can be chained together.

getEc2SubnetId

public String getEc2SubnetId()
To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Returns:
To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

setEc2SubnetId

public void setEc2SubnetId(String ec2SubnetId)
To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
ec2SubnetId - To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

withEc2SubnetId

public JobFlowInstancesConfig withEc2SubnetId(String ec2SubnetId)
To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

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

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Parameters:
ec2SubnetId - To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

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
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.