Package software.amazon.awssdk.services.ec2.model

Class TargetCapacitySpecification

java.lang.Object

software.amazon.awssdk.services.ec2.model.TargetCapacitySpecification

All Implemented Interfaces:

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

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

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice , or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetCapacitySpecification.Builder

Method Summary

Modifier and Type	Method	Description
static TargetCapacitySpecification.Builder	builder()
DefaultTargetCapacityType	defaultTargetCapacityType()	The default TotalTargetCapacity, which is either Spot or On-Demand.
String	defaultTargetCapacityTypeAsString()	The default TotalTargetCapacity, which is either Spot or On-Demand.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	onDemandTargetCapacity()	The number of On-Demand units to request.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetCapacitySpecification.Builder>	serializableBuilderClass()
Integer	spotTargetCapacity()	The maximum number of Spot units to launch.
TargetCapacityUnitType	targetCapacityUnitType()	The unit for the target capacity.
String	targetCapacityUnitTypeAsString()	The unit for the target capacity.
TargetCapacitySpecification.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalTargetCapacity()	The number of units to request, filled using DefaultTargetCapacityType.

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

totalTargetCapacity

public final Integer totalTargetCapacity()

The number of units to request, filled using DefaultTargetCapacityType.

Returns:

The number of units to request, filled using DefaultTargetCapacityType.

onDemandTargetCapacity

public final Integer onDemandTargetCapacity()

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

Returns:

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

spotTargetCapacity

public final Integer spotTargetCapacity()

The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.

Returns:

The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.

defaultTargetCapacityType

public final DefaultTargetCapacityType defaultTargetCapacityType()

The default TotalTargetCapacity, which is either Spot or On-Demand.

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

Returns:

The default TotalTargetCapacity, which is either Spot or On-Demand .

See Also:

DefaultTargetCapacityType

defaultTargetCapacityTypeAsString

public final String defaultTargetCapacityTypeAsString()

The default TotalTargetCapacity, which is either Spot or On-Demand.

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

Returns:

The default TotalTargetCapacity, which is either Spot or On-Demand .

See Also:

DefaultTargetCapacityType

targetCapacityUnitType

public final TargetCapacityUnitType targetCapacityUnitType()

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

Default: units (translates to number of instances)

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

Returns:

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

Default: units (translates to number of instances)

See Also:

TargetCapacityUnitType

targetCapacityUnitTypeAsString

public final String targetCapacityUnitTypeAsString()

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

Default: units (translates to number of instances)

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

Returns:

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

Default: units (translates to number of instances)

See Also:

TargetCapacityUnitType

toBuilder

public TargetCapacitySpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetCapacitySpecification.Builder,TargetCapacitySpecification>

builder

public static TargetCapacitySpecification.Builder builder()

serializableBuilderClass

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