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

Class CreateCapacityReservationFleetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateCapacityReservationFleetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCapacityReservationFleetRequest.Builder,CreateCapacityReservationFleetRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateCapacityReservationFleetRequest
extends Ec2Request
implements ToCopyableBuilder<CreateCapacityReservationFleetRequest.Builder,CreateCapacityReservationFleetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCapacityReservationFleetRequest.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 CreateCapacityReservationFleetRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
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	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications 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<ReservationFleetInstanceSpecification>	instanceTypeSpecifications()	Information about the instance types for which to reserve the capacity.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCapacityReservationFleetRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications()	The tags to assign to the Capacity Reservation Fleet.
FleetCapacityReservationTenancy	tenancy()	Indicates the tenancy of the Capacity Reservation Fleet.
String	tenancyAsString()	Indicates the tenancy of the Capacity Reservation Fleet.
CreateCapacityReservationFleetRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalTargetCapacity()	The total number of capacity units to be reserved by the Capacity Reservation Fleet.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

allocationStrategy

public final String allocationStrategy()

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

Valid values: prioritized

Returns:

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

Valid values: prioritized

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

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

tenancy

public final FleetCapacityReservationTenancy tenancy()

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

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

• dedicated - The Capacity Reservations are 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:

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

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

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

See Also:

FleetCapacityReservationTenancy

tenancyAsString

public final String tenancyAsString()

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

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

• dedicated - The Capacity Reservations are 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:

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

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

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

See Also:

FleetCapacityReservationTenancy

totalTargetCapacity

public final Integer totalTargetCapacity()

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.

Returns:

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.

endDate

public final Instant endDate()

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.

Returns:

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.

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

hasTagSpecifications

public final boolean hasTagSpecifications()

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

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the 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 hasTagSpecifications() method.

Returns:

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

toBuilder

public CreateCapacityReservationFleetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCapacityReservationFleetRequest.Builder,CreateCapacityReservationFleetRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateCapacityReservationFleetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCapacityReservationFleetRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo