Class InstanceFleet
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceFleet.Builder,
InstanceFleet>
Describes an instance fleet, which is a group of Amazon EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic InstanceFleet.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceTypeSpecifications property.final String
id()
The unique identifier of the instance fleet.final InstanceFleetType
The node type that the instance fleet hosts.final String
The node type that the instance fleet hosts.final List
<InstanceTypeSpecification> An array of specifications for the instance types that comprise an instance fleet.Describes the launch specification for an instance fleet.final String
name()
A friendly name for the instance fleet.final Integer
The number of On-Demand units that have been provisioned for the instance fleet to fulfillTargetOnDemandCapacity
.final Integer
The number of Spot units that have been provisioned for this instance fleet to fulfillTargetSpotCapacity
.The resize specification for the instance fleet.static Class
<? extends InstanceFleet.Builder> final InstanceFleetStatus
status()
The current status of the instance fleet.final Integer
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision.final Integer
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The unique identifier of the instance fleet.
- Returns:
- The unique identifier of the instance fleet.
-
name
A friendly name for the instance fleet.
- Returns:
- A friendly name for the instance fleet.
-
status
The current status of the instance fleet.
- Returns:
- The current status of the instance fleet.
-
instanceFleetType
The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
If the service returns an enum value that is not available in the current SDK version,
instanceFleetType
will returnInstanceFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceFleetTypeAsString()
.- Returns:
- The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
- See Also:
-
instanceFleetTypeAsString
The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
If the service returns an enum value that is not available in the current SDK version,
instanceFleetType
will returnInstanceFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceFleetTypeAsString()
.- Returns:
- The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
- See Also:
-
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, theWeightedCapacity
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 aWeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using
TargetSpotCapacity
. At least one ofTargetSpotCapacity
andTargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one ofTargetSpotCapacity
andTargetOnDemandCapacity
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, theWeightedCapacity
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 aWeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using
TargetSpotCapacity
. At least one ofTargetSpotCapacity
andTargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one ofTargetSpotCapacity
andTargetOnDemandCapacity
can be specified, and its value must be 1.
-
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, theWeightedCapacity
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 aWeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of
TargetSpotCapacity
andTargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one ofTargetSpotCapacity
andTargetOnDemandCapacity
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, theWeightedCapacity
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 aWeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of
TargetSpotCapacity
andTargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one ofTargetSpotCapacity
andTargetOnDemandCapacity
can be specified, and its value must be 1.
-
provisionedOnDemandCapacity
The number of On-Demand units that have been provisioned for the instance fleet to fulfill
TargetOnDemandCapacity
. This provisioned capacity might be less than or greater thanTargetOnDemandCapacity
.- Returns:
- The number of On-Demand units that have been provisioned for the instance fleet to fulfill
TargetOnDemandCapacity
. This provisioned capacity might be less than or greater thanTargetOnDemandCapacity
.
-
provisionedSpotCapacity
The number of Spot units that have been provisioned for this instance fleet to fulfill
TargetSpotCapacity
. This provisioned capacity might be less than or greater thanTargetSpotCapacity
.- Returns:
- The number of Spot units that have been provisioned for this instance fleet to fulfill
TargetSpotCapacity
. This provisioned capacity might be less than or greater thanTargetSpotCapacity
.
-
hasInstanceTypeSpecifications
public final boolean hasInstanceTypeSpecifications()For responses, this returns true if the service returned a value for the InstanceTypeSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
instanceTypeSpecifications
An array of specifications for the instance types that comprise an 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
hasInstanceTypeSpecifications()
method.- Returns:
- An array of specifications for the instance types that comprise an instance fleet.
-
launchSpecifications
Describes the launch specification for an instance fleet.
- Returns:
- Describes the launch specification for an instance fleet.
-
resizeSpecifications
The resize specification for the instance fleet.
- Returns:
- The resize specification for the instance fleet.
-
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 interfaceToCopyableBuilder<InstanceFleet.Builder,
InstanceFleet> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-