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>

  • Method Details

    • 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:

    • 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:

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

    • instanceMatchCriteria

      public final InstanceMatchCriteria instanceMatchCriteria()

      The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

      To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

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

      Returns:
      The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

      To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

      See Also:

    • instanceMatchCriteriaAsString

      public final String instanceMatchCriteriaAsString()

      The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

      To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

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

      Returns:
      The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

      To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

      See Also:

    • toBuilder

      public ModifyCapacityReservationRequest.Builder 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 interface ToCopyableBuilder<ModifyCapacityReservationRequest.Builder,ModifyCapacityReservationRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.