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

Class CapacityReservationFleet

java.lang.Object

software.amazon.awssdk.services.ec2.model.CapacityReservationFleet

All Implemented Interfaces:

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

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

Information about a Capacity Reservation Fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityReservationFleet.Builder

Method Summary

Modifier and Type	Method	Description
String	allocationStrategy()	The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
static CapacityReservationFleet.Builder	builder()
String	capacityReservationFleetArn()	The ARN of the Capacity Reservation Fleet.
String	capacityReservationFleetId()	The ID of the Capacity Reservation Fleet.
Instant	createTime()	The date and time at which the Capacity Reservation Fleet was created.
Instant	endDate()	The date and time at which the Capacity Reservation Fleet expires.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceTypeSpecifications()	For responses, this returns true if the service returned a value for the InstanceTypeSpecifications property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
FleetInstanceMatchCriteria	instanceMatchCriteria()	Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
String	instanceMatchCriteriaAsString()	Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
List<FleetCapacityReservation>	instanceTypeSpecifications()	Information about the instance types for which to reserve the capacity.
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityReservationFleet.Builder>	serializableBuilderClass()
CapacityReservationFleetState	state()	The state of the Capacity Reservation Fleet.
String	stateAsString()	The state of the Capacity Reservation Fleet.
List<Tag>	tags()	The tags assigned to the Capacity Reservation Fleet.
FleetCapacityReservationTenancy	tenancy()	The tenancy of the Capacity Reservation Fleet.
String	tenancyAsString()	The tenancy of the Capacity Reservation Fleet.
CapacityReservationFleet.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Double	totalFulfilledCapacity()	The capacity units that have been fulfilled.
Integer	totalTargetCapacity()	The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.

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

capacityReservationFleetId

public final String capacityReservationFleetId()

The ID of the Capacity Reservation Fleet.

Returns:

The ID of the Capacity Reservation Fleet.

capacityReservationFleetArn

public final String capacityReservationFleetArn()

The ARN of the Capacity Reservation Fleet.

Returns:

The ARN of the Capacity Reservation Fleet.

state

public final CapacityReservationFleetState state()

The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

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

Returns:

The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

See Also:

CapacityReservationFleetState

stateAsString

public final String stateAsString()

The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

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

Returns:

The state of the Capacity Reservation Fleet. Possible states include:

• submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

• modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

• active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

• partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

• expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

• expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

• cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

• cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

• failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

See Also:

CapacityReservationFleetState

totalTargetCapacity

public final Integer totalTargetCapacity()

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.

Returns:

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.

totalFulfilledCapacity

public final Double totalFulfilledCapacity()

The capacity units that have been fulfilled.

Returns:

The capacity units that have been fulfilled.

tenancy

public final FleetCapacityReservationTenancy tenancy()

The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

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

Returns:

The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

See Also:

FleetCapacityReservationTenancy

tenancyAsString

public final String tenancyAsString()

The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

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

Returns:

The tenancy of the Capacity Reservation Fleet. Tenancies include:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

• dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

See Also:

FleetCapacityReservationTenancy

endDate

public final Instant endDate()

The date and time at which the Capacity Reservation Fleet expires.

Returns:

The date and time at which the Capacity Reservation Fleet expires.

createTime

public final Instant createTime()

The date and time at which the Capacity Reservation Fleet was created.

Returns:

The date and time at which the Capacity Reservation Fleet was created.

instanceMatchCriteria

public final FleetInstanceMatchCriteria instanceMatchCriteria()

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

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

Returns:

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

See Also:

FleetInstanceMatchCriteria

instanceMatchCriteriaAsString

public final String instanceMatchCriteriaAsString()

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

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

Returns:

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

See Also:

FleetInstanceMatchCriteria

allocationStrategy

public final String allocationStrategy()

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the Amazon EC2 User Guide.

Returns:

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the Amazon EC2 User Guide.

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 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.

instanceTypeSpecifications

public final List<FleetCapacityReservation> instanceTypeSpecifications()

Information about the instance types for which to reserve the capacity.

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:

Information about the instance types for which to reserve the capacity.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

The tags assigned to the Capacity Reservation 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 hasTags() method.

Returns:

The tags assigned to the Capacity Reservation Fleet.

toBuilder

public CapacityReservationFleet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityReservationFleet.Builder,CapacityReservationFleet>

builder

public static CapacityReservationFleet.Builder builder()

serializableBuilderClass

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