You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::ModifyCapacityReservationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyCapacityReservationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  capacity_reservation_id: "CapacityReservationId", # required
  instance_count: 1,
  end_date: Time.now,
  end_date_type: "unlimited", # accepts unlimited, limited
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

  • (String) —

    The ID of the Capacity Reservation.

#dry_run ⇒ Boolean

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:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#end_date ⇒ Time

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:

  • (Time) —

    The date and time at which the Capacity Reservation expires.

#end_date_type ⇒ String

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.

    Possible values:

    • unlimited
    • limited

Returns:

  • (String) —

    Indicates the way in which the Capacity Reservation ends.

#instance_count ⇒ Integer

The number of instances for which to reserve capacity.

Returns:

  • (Integer) —

    The number of instances for which to reserve capacity.