Class InstanceFleetConfig

java.lang.Object
software.amazon.awssdk.services.emr.model.InstanceFleetConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceFleetConfig.Builder,InstanceFleetConfig>

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

The configuration that defines an instance fleet.

The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.

See Also:
  • Method Details

    • name

      public final String name()

      The friendly name of the instance fleet.

      Returns:
      The friendly name of the instance fleet.
    • instanceFleetType

      public final InstanceFleetType instanceFleetType()

      The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.

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

      Returns:
      The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
      See Also:
    • instanceFleetTypeAsString

      public final String instanceFleetTypeAsString()

      The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.

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

      Returns:
      The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
      See Also:
    • targetOnDemandCapacity

      public final Integer targetOnDemandCapacity()

      The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

      If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

      Returns:
      The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

      If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

    • targetSpotCapacity

      public final Integer targetSpotCapacity()

      The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

      If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

      Returns:
      The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

      If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

    • hasInstanceTypeConfigs

      public final boolean hasInstanceTypeConfigs()
      For responses, this returns true if the service returned a value for the InstanceTypeConfigs 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.
    • instanceTypeConfigs

      public final List<InstanceTypeConfig> instanceTypeConfigs()

      The instance type configurations that define the Amazon EC2 instances in the instance fleet.

      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 hasInstanceTypeConfigs() method.

      Returns:
      The instance type configurations that define the Amazon EC2 instances in the instance fleet.
    • launchSpecifications

      public final InstanceFleetProvisioningSpecifications launchSpecifications()

      The launch specification for the instance fleet.

      Returns:
      The launch specification for the instance fleet.
    • resizeSpecifications

      public final InstanceFleetResizingSpecifications resizeSpecifications()

      The resize specification for the instance fleet.

      Returns:
      The resize specification for the instance fleet.
    • toBuilder

      public InstanceFleetConfig.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<InstanceFleetConfig.Builder,InstanceFleetConfig>
      Returns:
      a builder for type T
    • builder

      public static InstanceFleetConfig.Builder builder()
    • serializableBuilderClass

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