InstanceGroup (AWS Java SDK :: Services :: Amazon EMR 2.17.41 API)

java.lang.Object
- software.amazon.awssdk.services.emr.model.InstanceGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class InstanceGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InstanceGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstanceGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoScalingPolicyDescription`	`autoScalingPolicy()` An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.
`String`	`bidPrice()` If specified, indicates that the instance group uses Spot Instances.
`static InstanceGroup.Builder`	`builder()`
`List<Configuration>`	`configurations()`
`Long`	`configurationsVersion()` The version number of the requested configuration specification for this instance group.
`String`	`customAmiId()` The custom AMI ID to use for the provisioned instance group.
`List<EbsBlockDevice>`	`ebsBlockDevices()` The EBS block devices that are mapped to this instance group.
`Boolean`	`ebsOptimized()` If the instance group is EBS-optimized.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasConfigurations()` For responses, this returns true if the service returned a value for the Configurations property.
`boolean`	`hasEbsBlockDevices()` For responses, this returns true if the service returned a value for the EbsBlockDevices property.
`int`	`hashCode()`
`boolean`	`hasLastSuccessfullyAppliedConfigurations()` For responses, this returns true if the service returned a value for the LastSuccessfullyAppliedConfigurations property.
`String`	`id()` The identifier of the instance group.
`InstanceGroupType`	`instanceGroupType()` The type of the instance group.
`String`	`instanceGroupTypeAsString()` The type of the instance group.
`String`	`instanceType()` The EC2 instance type for all instances in the instance group.
`List<Configuration>`	`lastSuccessfullyAppliedConfigurations()` A list of configurations that were successfully applied for an instance group last time.
`Long`	`lastSuccessfullyAppliedConfigurationsVersion()` The version number of a configuration specification that was successfully applied for an instance group last time.
`MarketType`	`market()` The marketplace to provision instances for this group.
`String`	`marketAsString()` The marketplace to provision instances for this group.
`String`	`name()` The name of the instance group.
`Integer`	`requestedInstanceCount()` The target number of instances for the instance group.
`Integer`	`runningInstanceCount()` The number of instances currently running in this instance group.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstanceGroup.Builder>`	`serializableBuilderClass()`
`ShrinkPolicy`	`shrinkPolicy()` Policy for customizing shrink operations.
`InstanceGroupStatus`	`status()` The current status of the instance group.
`InstanceGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final String id()
```
    The identifier of the instance group.
    
    Returns:
    
    The identifier of the instance group.
  - name
```
public final String name()
```
    The name of the instance group.
    
    Returns:
    
    The name of the instance group.
  - market
```
public final MarketType market()
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    If the service returns an enum value that is not available in the current SDK version, market will return MarketType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from marketAsString().
    
    Returns:
    
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    See Also:
    
    MarketType
  - marketAsString
```
public final String marketAsString()
```
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    If the service returns an enum value that is not available in the current SDK version, market will return MarketType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from marketAsString().
    
    Returns:
    
    The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
    
    See Also:
    
    MarketType
  - instanceGroupType
```
public final InstanceGroupType instanceGroupType()
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    If the service returns an enum value that is not available in the current SDK version, instanceGroupType will return InstanceGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceGroupTypeAsString().
    
    Returns:
    
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    See Also:
    
    InstanceGroupType
  - instanceGroupTypeAsString
```
public final String instanceGroupTypeAsString()
```
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    If the service returns an enum value that is not available in the current SDK version, instanceGroupType will return InstanceGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceGroupTypeAsString().
    
    Returns:
    
    The type of the instance group. Valid values are MASTER, CORE or TASK.
    
    See Also:
    
    InstanceGroupType
  - bidPrice
```
public final String bidPrice()
```
    If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.
    
    Returns:
    
    If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.
  - instanceType
```
public final String instanceType()
```
    The EC2 instance type for all instances in the instance group.
    
    Returns:
    
    The EC2 instance type for all instances in the instance group.
  - requestedInstanceCount
```
public final Integer requestedInstanceCount()
```
    The target number of instances for the instance group.
    
    Returns:
    
    The target number of instances for the instance group.
  - runningInstanceCount
```
public final Integer runningInstanceCount()
```
    The number of instances currently running in this instance group.
    
    Returns:
    
    The number of instances currently running in this instance group.
  - status
```
public final InstanceGroupStatus status()
```
    The current status of the instance group.
    
    Returns:
    
    The current status of the instance group.
  - hasConfigurations
```
public final boolean hasConfigurations()
```
    For responses, this returns true if the service returned a value for the Configurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - configurations
```
public final List<Configuration> configurations()
```
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfigurations() method.
    
    Returns:
    
    Amazon EMR releases 4.x or later.
    
    The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
  - configurationsVersion
```
public final Long configurationsVersion()
```
    The version number of the requested configuration specification for this instance group.
    
    Returns:
    
    The version number of the requested configuration specification for this instance group.
  - hasLastSuccessfullyAppliedConfigurations
```
public final boolean hasLastSuccessfullyAppliedConfigurations()
```
    For responses, this returns true if the service returned a value for the LastSuccessfullyAppliedConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - lastSuccessfullyAppliedConfigurations
```
public final List<Configuration> lastSuccessfullyAppliedConfigurations()
```
    A list of configurations that were successfully applied for an instance group last time.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLastSuccessfullyAppliedConfigurations() method.
    
    Returns:
    
    A list of configurations that were successfully applied for an instance group last time.
  - lastSuccessfullyAppliedConfigurationsVersion
```
public final Long lastSuccessfullyAppliedConfigurationsVersion()
```
    The version number of a configuration specification that was successfully applied for an instance group last time.
    
    Returns:
    
    The version number of a configuration specification that was successfully applied for an instance group last time.
  - hasEbsBlockDevices
```
public final boolean hasEbsBlockDevices()
```
    For responses, this returns true if the service returned a value for the EbsBlockDevices property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - ebsBlockDevices
```
public final List<EbsBlockDevice> ebsBlockDevices()
```
    The EBS block devices that are mapped to this instance group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEbsBlockDevices() method.
    
    Returns:
    
    The EBS block devices that are mapped to this instance group.
  - ebsOptimized
```
public final 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.
    
    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.
  - shrinkPolicy
```
public final ShrinkPolicy shrinkPolicy()
```
    Policy for customizing shrink operations.
    
    Returns:
    
    Policy for customizing shrink operations.
  - autoScalingPolicy
```
public final 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.
    
    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.
  - customAmiId
```
public final String customAmiId()
```
    The custom AMI ID to use for the provisioned instance group.
    
    Returns:
    
    The custom AMI ID to use for the provisioned instance group.
  - toBuilder
```
public InstanceGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>
  - builder
```
public static InstanceGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InstanceGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class InstanceGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

market

marketAsString

instanceGroupType

instanceGroupTypeAsString

bidPrice

instanceType

requestedInstanceCount

runningInstanceCount

status

hasConfigurations

configurations

configurationsVersion

hasLastSuccessfullyAppliedConfigurations

lastSuccessfullyAppliedConfigurations

lastSuccessfullyAppliedConfigurationsVersion

hasEbsBlockDevices

ebsBlockDevices

ebsOptimized

shrinkPolicy

autoScalingPolicy

customAmiId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields