Interface ModifyCapacityReservationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ModifyCapacityReservationRequest.Builder,ModifyCapacityReservationRequest>, Ec2Request.Builder, SdkBuilder<ModifyCapacityReservationRequest.Builder,ModifyCapacityReservationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ModifyCapacityReservationRequest
@Mutable @NotThreadSafe public static interface ModifyCapacityReservationRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ModifyCapacityReservationRequest.Builder,ModifyCapacityReservationRequest>

  • Method Details

    • capacityReservationId

      ModifyCapacityReservationRequest.Builder capacityReservationId(String capacityReservationId)

      The ID of the Capacity Reservation.

      Parameters:
      capacityReservationId - The ID of the Capacity Reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceCount

      ModifyCapacityReservationRequest.Builder instanceCount(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • endDate

      ModifyCapacityReservationRequest.Builder endDate(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • endDateType

      ModifyCapacityReservationRequest.Builder endDateType(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endDateType

      ModifyCapacityReservationRequest.Builder endDateType(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accept

      ModifyCapacityReservationRequest.Builder accept(Boolean accept)

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

      Parameters:
      accept - Reserved. Capacity Reservations you have created are accepted by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      ModifyCapacityReservationRequest.Builder dryRun(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInfo

      ModifyCapacityReservationRequest.Builder additionalInfo(String additionalInfo)

      Reserved for future use.

      Parameters:
      additionalInfo - Reserved for future use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMatchCriteria

      ModifyCapacityReservationRequest.Builder instanceMatchCriteria(String 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).

      Parameters:
      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).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceMatchCriteria

      ModifyCapacityReservationRequest.Builder instanceMatchCriteria(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).

      Parameters:
      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).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • acceptModificationTerms

      ModifyCapacityReservationRequest.Builder acceptModificationTerms(Boolean acceptModificationTerms)

      Indicates that you accept the modification terms of the quote identified by QuoteId. To apply a quoted modification, set this parameter to true.

      Parameters:
      acceptModificationTerms - Indicates that you accept the modification terms of the quote identified by QuoteId. To apply a quoted modification, set this parameter to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDate

      ModifyCapacityReservationRequest.Builder startDate(Instant startDate)

      The new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). Applies to future-dated Capacity Reservations only. Requires a quote from CreateCapacityReservationDateChangeQuote; pass the quote ID in QuoteId with AcceptModificationTerms set to true.

      Parameters:
      startDate - The new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). Applies to future-dated Capacity Reservations only. Requires a quote from CreateCapacityReservationDateChangeQuote; pass the quote ID in QuoteId with AcceptModificationTerms set to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quoteId

      ModifyCapacityReservationRequest.Builder quoteId(String quoteId)

      The ID of the quote that describes the modification you want to apply. Generate a quote by using CreateCapacityReservationDateChangeQuote. The quote must be in the active state, and each quote can be used only once.

      Parameters:
      quoteId - The ID of the quote that describes the modification you want to apply. Generate a quote by using CreateCapacityReservationDateChangeQuote. The quote must be in the active state, and each quote can be used only once.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ModifyCapacityReservationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ModifyCapacityReservationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.