software.amazon.awssdk.services.emr.model

Class InstanceGroupConfig

java.lang.Object

software.amazon.awssdk.services.emr.model.InstanceGroupConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceGroupConfig.Builder,InstanceGroupConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class InstanceGroupConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstanceGroupConfig.Builder,InstanceGroupConfig>

Configuration defining a new instance group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceGroupConfig.Builder

Method Summary

Modifier and Type	Method and Description
AutoScalingPolicy	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 InstanceGroupConfig.Builder	builder()
List<Configuration>	configurations()
String	customAmiId() The custom AMI ID to use for the provisioned instance group.
EbsConfiguration	ebsConfiguration() EBS configurations that will be attached to each EC2 instance in the instance group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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.
int	hashCode()
Integer	instanceCount() Target number of instances for the instance group.
InstanceRoleType	instanceRole() The role of the instance group in the cluster.
String	instanceRoleAsString() The role of the instance group in the cluster.
String	instanceType() The EC2 instance type for all instances in the instance group.
MarketType	market() Market type of the EC2 instances used to create a cluster node.
String	marketAsString() Market type of the EC2 instances used to create a cluster node.
String	name() Friendly name given to the instance group.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceGroupConfig.Builder>	serializableBuilderClass()
InstanceGroupConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

Friendly name given to the instance group.

Returns:

Friendly name given to the instance group.

market

public final MarketType market()

Market type of the EC2 instances used to create a cluster node.

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:

Market type of the EC2 instances used to create a cluster node.

See Also:

MarketType

marketAsString

public final String marketAsString()

Market type of the EC2 instances used to create a cluster node.

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:

Market type of the EC2 instances used to create a cluster node.

See Also:

MarketType

instanceRole

public final InstanceRoleType instanceRole()

The role of the instance group in the cluster.

If the service returns an enum value that is not available in the current SDK version, instanceRole will return InstanceRoleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceRoleAsString().

Returns:

The role of the instance group in the cluster.

See Also:

InstanceRoleType

instanceRoleAsString

public final String instanceRoleAsString()

The role of the instance group in the cluster.

If the service returns an enum value that is not available in the current SDK version, instanceRole will return InstanceRoleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceRoleAsString().

Returns:

The role of the instance group in the cluster.

See Also:

InstanceRoleType

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.

instanceCount

public final Integer instanceCount()

Target number of instances for the instance group.

Returns:

Target number of instances for 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 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 EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

ebsConfiguration

public final EbsConfiguration ebsConfiguration()

EBS configurations that will be attached to each EC2 instance in the instance group.

Returns:

EBS configurations that will be attached to each EC2 instance in the instance group.

autoScalingPolicy

public final AutoScalingPolicy 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 InstanceGroupConfig.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceGroupConfig.Builder,InstanceGroupConfig>

Returns:

a builder for type T

builder

public static InstanceGroupConfig.Builder builder()

serializableBuilderClass

public static Class<? extends InstanceGroupConfig.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.