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

Class ModifyCapacityReservationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyCapacityReservationRequest.Builder,ModifyCapacityReservationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyCapacityReservationRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	accept()	Reserved.
String	additionalInfo()	Reserved for future use.
static ModifyCapacityReservationRequest.Builder	builder()
String	capacityReservationId()	The ID of the Capacity Reservation.
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 expires.
EndDateType	endDateType()	Indicates the way in which the Capacity Reservation ends.
String	endDateTypeAsString()	Indicates the way in which the Capacity Reservation ends.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount()	The number of instances for which to reserve capacity.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyCapacityReservationRequest.Builder>	serializableBuilderClass()
ModifyCapacityReservationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

capacityReservationId

public final String capacityReservationId()

The ID of the Capacity Reservation.

Returns:

The ID of the Capacity Reservation.

instanceCount

public final Integer instanceCount()

The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.

Returns:

The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.

endDate

public final Instant endDate()

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

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

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

Returns:

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

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

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

endDateType

public final EndDateType endDateType()

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

• unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.

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

Returns:

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

• unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.

See Also:

EndDateType

endDateTypeAsString

public final String endDateTypeAsString()

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

• unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.

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

Returns:

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

• unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.

See Also:

EndDateType

accept

public final Boolean accept()

Reserved. Capacity Reservations you have created are accepted by default.

Returns:

Reserved. Capacity Reservations you have created are accepted by default.

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.

additionalInfo

public final String additionalInfo()

Reserved for future use.

Returns:

Reserved for future use.

toBuilder

public ModifyCapacityReservationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyCapacityReservationRequest.Builder,ModifyCapacityReservationRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyCapacityReservationRequest.Builder builder()

serializableBuilderClass

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