InstanceGroup (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InstanceGroup
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstanceGroup()

Constructors
Constructor and Description
`InstanceGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstanceGroup`	`clone()`
`boolean`	`equals(Object obj)`
`AutoScalingPolicyDescription`	`getAutoScalingPolicy()` An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
`String`	`getBidPrice()` The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
`List<Configuration>`	`getConfigurations()`
`List<EbsBlockDevice>`	`getEbsBlockDevices()` The EBS block devices that are mapped to this instance group.
`Boolean`	`getEbsOptimized()` If the instance group is EBS-optimized.
`String`	`getId()` The identifier of the instance group.
`String`	`getInstanceGroupType()` The type of the instance group.
`String`	`getInstanceType()` The EC2 instance type for all instances in the instance group.
`String`	`getMarket()` The marketplace to provision instances for this group.
`String`	`getName()` The name of the instance group.
`Integer`	`getRequestedInstanceCount()` The target number of instances for the instance group.
`Integer`	`getRunningInstanceCount()` The number of instances currently running in this instance group.
`ShrinkPolicy`	`getShrinkPolicy()` Policy for customizing shrink operations.
`InstanceGroupStatus`	`getStatus()` The current status of the instance group.
`int`	`hashCode()`
`Boolean`	`isEbsOptimized()` If the instance group is EBS-optimized.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAutoScalingPolicy(AutoScalingPolicyDescription autoScalingPolicy)` An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
`void`	`setBidPrice(String bidPrice)` The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
`void`	`setConfigurations(Collection<Configuration> configurations)`
`void`	`setEbsBlockDevices(Collection<EbsBlockDevice> ebsBlockDevices)` The EBS block devices that are mapped to this instance group.
`void`	`setEbsOptimized(Boolean ebsOptimized)` If the instance group is EBS-optimized.
`void`	`setId(String id)` The identifier of the instance group.
`void`	`setInstanceGroupType(InstanceGroupType instanceGroupType)` The type of the instance group.
`void`	`setInstanceGroupType(String instanceGroupType)` The type of the instance group.
`void`	`setInstanceType(String instanceType)` The EC2 instance type for all instances in the instance group.
`void`	`setMarket(MarketType market)` The marketplace to provision instances for this group.
`void`	`setMarket(String market)` The marketplace to provision instances for this group.
`void`	`setName(String name)` The name of the instance group.
`void`	`setRequestedInstanceCount(Integer requestedInstanceCount)` The target number of instances for the instance group.
`void`	`setRunningInstanceCount(Integer runningInstanceCount)` The number of instances currently running in this instance group.
`void`	`setShrinkPolicy(ShrinkPolicy shrinkPolicy)` Policy for customizing shrink operations.
`void`	`setStatus(InstanceGroupStatus status)` The current status of the instance group.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InstanceGroup`	`withAutoScalingPolicy(AutoScalingPolicyDescription autoScalingPolicy)` An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
`InstanceGroup`	`withBidPrice(String bidPrice)` The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
`InstanceGroup`	`withConfigurations(Collection<Configuration> configurations)`
`InstanceGroup`	`withConfigurations(Configuration... configurations)`
`InstanceGroup`	`withEbsBlockDevices(Collection<EbsBlockDevice> ebsBlockDevices)` The EBS block devices that are mapped to this instance group.
`InstanceGroup`	`withEbsBlockDevices(EbsBlockDevice... ebsBlockDevices)` The EBS block devices that are mapped to this instance group.
`InstanceGroup`	`withEbsOptimized(Boolean ebsOptimized)` If the instance group is EBS-optimized.
`InstanceGroup`	`withId(String id)` The identifier of the instance group.
`InstanceGroup`	`withInstanceGroupType(InstanceGroupType instanceGroupType)` The type of the instance group.
`InstanceGroup`	`withInstanceGroupType(String instanceGroupType)` The type of the instance group.
`InstanceGroup`	`withInstanceType(String instanceType)` The EC2 instance type for all instances in the instance group.
`InstanceGroup`	`withMarket(MarketType market)` The marketplace to provision instances for this group.
`InstanceGroup`	`withMarket(String market)` The marketplace to provision instances for this group.
`InstanceGroup`	`withName(String name)` The name of the instance group.
`InstanceGroup`	`withRequestedInstanceCount(Integer requestedInstanceCount)` The target number of instances for the instance group.
`InstanceGroup`	`withRunningInstanceCount(Integer runningInstanceCount)` The number of instances currently running in this instance group.
`InstanceGroup`	`withShrinkPolicy(ShrinkPolicy shrinkPolicy)` Policy for customizing shrink operations.
`InstanceGroup`	`withStatus(InstanceGroupStatus status)` The current status of the instance group.

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

- Constructor Detail
  - InstanceGroup
```
public InstanceGroup()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the instance group.
    
    Parameters:
    
    id - The identifier of the instance group.
  - getId
```
public String getId()
```
    The identifier of the instance group.
    
    Returns:
    
    The identifier of the instance group.
  - withId
```
public InstanceGroup withId(String id)
```
    The identifier of the instance group.
    
    Parameters:
    
    id - The identifier of the instance group.
    
    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 instance group.
    
    Parameters:
    
    name - The name of the instance group.
  - getName
```
public String getName()
```
    The name of the instance group.
    
    Returns:
    
    The name of the instance group.
  - withName
```
public InstanceGroup withName(String name)
```
    The name of the instance group.
    
    Parameters:
    
    name - The name of the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMarket
```
public void setMarket(String market)
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Parameters:
    
    market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    See Also:
    
    MarketType
  - getMarket
```
public String getMarket()
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Returns:
    
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    See Also:
    
    MarketType
  - withMarket
```
public InstanceGroup withMarket(String market)
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Parameters:
    
    market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MarketType
  - setMarket
```
public void setMarket(MarketType market)
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Parameters:
    
    market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    See Also:
    
    MarketType
  - withMarket
```
public InstanceGroup withMarket(MarketType market)
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Parameters:
    
    market - The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MarketType
  - setInstanceGroupType
```
public void setInstanceGroupType(String instanceGroupType)
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Parameters:
    
    instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    See Also:
    
    InstanceGroupType
  - getInstanceGroupType
```
public String getInstanceGroupType()
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Returns:
    
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    See Also:
    
    InstanceGroupType
  - withInstanceGroupType
```
public InstanceGroup withInstanceGroupType(String instanceGroupType)
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Parameters:
    
    instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceGroupType
  - setInstanceGroupType
```
public void setInstanceGroupType(InstanceGroupType instanceGroupType)
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Parameters:
    
    instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    See Also:
    
    InstanceGroupType
  - withInstanceGroupType
```
public InstanceGroup withInstanceGroupType(InstanceGroupType instanceGroupType)
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Parameters:
    
    instanceGroupType - The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceGroupType
  - setBidPrice
```
public void setBidPrice(String bidPrice)
```
    The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
    
    Parameters:
    
    bidPrice - The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
  - getBidPrice
```
public String getBidPrice()
```
    The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
    
    Returns:
    
    The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
  - withBidPrice
```
public InstanceGroup withBidPrice(String bidPrice)
```
    The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
    
    Parameters:
    
    bidPrice - The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The EC2 instance type for all instances in the instance group.
    
    Parameters:
    
    instanceType - The EC2 instance type for all instances in the instance group.
  - getInstanceType
```
public String getInstanceType()
```
    The EC2 instance type for all instances in the instance group.
    
    Returns:
    
    The EC2 instance type for all instances in the instance group.
  - withInstanceType
```
public InstanceGroup withInstanceType(String instanceType)
```
    The EC2 instance type for all instances in the instance group.
    
    Parameters:
    
    instanceType - The EC2 instance type for all instances in the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestedInstanceCount
```
public void setRequestedInstanceCount(Integer requestedInstanceCount)
```
    The target number of instances for the instance group.
    
    Parameters:
    
    requestedInstanceCount - The target number of instances for the instance group.
  - getRequestedInstanceCount
```
public Integer getRequestedInstanceCount()
```
    The target number of instances for the instance group.
    
    Returns:
    
    The target number of instances for the instance group.
  - withRequestedInstanceCount
```
public InstanceGroup withRequestedInstanceCount(Integer requestedInstanceCount)
```
    The target number of instances for the instance group.
    
    Parameters:
    
    requestedInstanceCount - The target number of instances for the instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRunningInstanceCount
```
public void setRunningInstanceCount(Integer runningInstanceCount)
```
    The number of instances currently running in this instance group.
    
    Parameters:
    
    runningInstanceCount - The number of instances currently running in this instance group.
  - getRunningInstanceCount
```
public Integer getRunningInstanceCount()
```
    The number of instances currently running in this instance group.
    
    Returns:
    
    The number of instances currently running in this instance group.
  - withRunningInstanceCount
```
public InstanceGroup withRunningInstanceCount(Integer runningInstanceCount)
```
    The number of instances currently running in this instance group.
    
    Parameters:
    
    runningInstanceCount - The number of instances currently running in this instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(InstanceGroupStatus status)
```
    The current status of the instance group.
    
    Parameters:
    
    status - The current status of the instance group.
  - getStatus
```
public InstanceGroupStatus getStatus()
```
    The current status of the instance group.
    
    Returns:
    
    The current status of the instance group.
  - withStatus
```
public InstanceGroup withStatus(InstanceGroupStatus status)
```
    The current status of the instance group.
    
    Parameters:
    
    status - The current status of the instance group.
    
    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 for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    Returns:
    
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
  - setConfigurations
```
public void setConfigurations(Collection<Configuration> configurations)
```
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    Parameters:
    
    configurations -
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
  - withConfigurations
```
public InstanceGroup withConfigurations(Configuration... configurations)
```
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    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.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withConfigurations
```
public InstanceGroup withConfigurations(Collection<Configuration> configurations)
```
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    Parameters:
    
    configurations -
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEbsBlockDevices
```
public List<EbsBlockDevice> getEbsBlockDevices()
```
    The EBS block devices that are mapped to this instance group.
    
    Returns:
    
    The EBS block devices that are mapped to this instance group.
  - setEbsBlockDevices
```
public void setEbsBlockDevices(Collection<EbsBlockDevice> ebsBlockDevices)
```
    The EBS block devices that are mapped to this instance group.
    
    Parameters:
    
    ebsBlockDevices - The EBS block devices that are mapped to this instance group.
  - withEbsBlockDevices
```
public InstanceGroup withEbsBlockDevices(EbsBlockDevice... ebsBlockDevices)
```
    The EBS block devices that are mapped to this instance group.
    
    NOTE: This method appends the values to the existing list (if any). Use setEbsBlockDevices(java.util.Collection) or withEbsBlockDevices(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ebsBlockDevices - The EBS block devices that are mapped to this instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEbsBlockDevices
```
public InstanceGroup withEbsBlockDevices(Collection<EbsBlockDevice> ebsBlockDevices)
```
    The EBS block devices that are mapped to this instance group.
    
    Parameters:
    
    ebsBlockDevices - The EBS block devices that are mapped to this instance group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEbsOptimized
```
public void setEbsOptimized(Boolean ebsOptimized)
```
    If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
    
    Parameters:
    
    ebsOptimized - If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
  - getEbsOptimized
```
public Boolean getEbsOptimized()
```
    If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
    
    Returns:
    
    If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
  - withEbsOptimized
```
public InstanceGroup withEbsOptimized(Boolean ebsOptimized)
```
    If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
    
    Parameters:
    
    ebsOptimized - If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEbsOptimized
```
public Boolean isEbsOptimized()
```
    If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
    
    Returns:
    
    If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
  - setShrinkPolicy
```
public void setShrinkPolicy(ShrinkPolicy shrinkPolicy)
```
    Policy for customizing shrink operations.
    
    Parameters:
    
    shrinkPolicy - Policy for customizing shrink operations.
  - getShrinkPolicy
```
public ShrinkPolicy getShrinkPolicy()
```
    Policy for customizing shrink operations.
    
    Returns:
    
    Policy for customizing shrink operations.
  - withShrinkPolicy
```
public InstanceGroup withShrinkPolicy(ShrinkPolicy shrinkPolicy)
```
    Policy for customizing shrink operations.
    
    Parameters:
    
    shrinkPolicy - Policy for customizing shrink operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoScalingPolicy
```
public void setAutoScalingPolicy(AutoScalingPolicyDescription autoScalingPolicy)
```
    An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
    
    Parameters:
    
    autoScalingPolicy - An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
  - getAutoScalingPolicy
```
public AutoScalingPolicyDescription getAutoScalingPolicy()
```
    An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
    
    Returns:
    
    An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
  - withAutoScalingPolicy
```
public InstanceGroup withAutoScalingPolicy(AutoScalingPolicyDescription autoScalingPolicy)
```
    An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
    
    Parameters:
    
    autoScalingPolicy - An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
    
    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:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public InstanceGroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class InstanceGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceGroup

Method Detail

setId

getId

withId

setName

getName

withName

setMarket

getMarket

withMarket

setMarket

withMarket

setInstanceGroupType

getInstanceGroupType

withInstanceGroupType

setInstanceGroupType

withInstanceGroupType

setBidPrice

getBidPrice

withBidPrice

setInstanceType

getInstanceType

withInstanceType

setRequestedInstanceCount

getRequestedInstanceCount

withRequestedInstanceCount

setRunningInstanceCount

getRunningInstanceCount

withRunningInstanceCount

setStatus

getStatus

withStatus

getConfigurations

setConfigurations

withConfigurations

withConfigurations

getEbsBlockDevices

setEbsBlockDevices

withEbsBlockDevices

withEbsBlockDevices

setEbsOptimized

getEbsOptimized

withEbsOptimized

isEbsOptimized

setShrinkPolicy

getShrinkPolicy

withShrinkPolicy

setAutoScalingPolicy

getAutoScalingPolicy

withAutoScalingPolicy

toString

equals

hashCode

clone

marshall