| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.ModifyCapacityReservationFleet
Description
Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
Synopsis
- data ModifyCapacityReservationFleet = ModifyCapacityReservationFleet' {}
- newModifyCapacityReservationFleet :: Text -> ModifyCapacityReservationFleet
- modifyCapacityReservationFleet_dryRun :: Lens' ModifyCapacityReservationFleet (Maybe Bool)
- modifyCapacityReservationFleet_endDate :: Lens' ModifyCapacityReservationFleet (Maybe UTCTime)
- modifyCapacityReservationFleet_removeEndDate :: Lens' ModifyCapacityReservationFleet (Maybe Bool)
- modifyCapacityReservationFleet_totalTargetCapacity :: Lens' ModifyCapacityReservationFleet (Maybe Int)
- modifyCapacityReservationFleet_capacityReservationFleetId :: Lens' ModifyCapacityReservationFleet Text
- data ModifyCapacityReservationFleetResponse = ModifyCapacityReservationFleetResponse' {
- return' :: Maybe Bool
- httpStatus :: Int
- newModifyCapacityReservationFleetResponse :: Int -> ModifyCapacityReservationFleetResponse
- modifyCapacityReservationFleetResponse_return :: Lens' ModifyCapacityReservationFleetResponse (Maybe Bool)
- modifyCapacityReservationFleetResponse_httpStatus :: Lens' ModifyCapacityReservationFleetResponse Int
Creating a Request
data ModifyCapacityReservationFleet Source #
See: newModifyCapacityReservationFleet smart constructor.
Constructors
| ModifyCapacityReservationFleet' | |
Fields
| |
Instances
newModifyCapacityReservationFleet Source #
Create a value of ModifyCapacityReservationFleet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:ModifyCapacityReservationFleet', modifyCapacityReservationFleet_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.
ModifyCapacityReservationFleet, modifyCapacityReservationFleet_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.
You can't specify EndDate and RemoveEndDate in the same request.
$sel:removeEndDate:ModifyCapacityReservationFleet', modifyCapacityReservationFleet_removeEndDate - Indicates whether to remove the end date from the Capacity Reservation
Fleet. If you remove the end date, the Capacity Reservation Fleet does
not expire and it remains active until you explicitly cancel it using
the CancelCapacityReservationFleet action.
You can't specify RemoveEndDate and EndDate in the same request.
ModifyCapacityReservationFleet, modifyCapacityReservationFleet_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.
ModifyCapacityReservationFleet, modifyCapacityReservationFleet_capacityReservationFleetId - The ID of the Capacity Reservation Fleet to modify.
Request Lenses
modifyCapacityReservationFleet_dryRun :: Lens' ModifyCapacityReservationFleet (Maybe Bool) Source #
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.
modifyCapacityReservationFleet_endDate :: Lens' ModifyCapacityReservationFleet (Maybe UTCTime) Source #
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.
You can't specify EndDate and RemoveEndDate in the same request.
modifyCapacityReservationFleet_removeEndDate :: Lens' ModifyCapacityReservationFleet (Maybe Bool) Source #
Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can't specify RemoveEndDate and EndDate in the same request.
modifyCapacityReservationFleet_totalTargetCapacity :: Lens' ModifyCapacityReservationFleet (Maybe Int) Source #
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.
modifyCapacityReservationFleet_capacityReservationFleetId :: Lens' ModifyCapacityReservationFleet Text Source #
The ID of the Capacity Reservation Fleet to modify.
Destructuring the Response
data ModifyCapacityReservationFleetResponse Source #
See: newModifyCapacityReservationFleetResponse smart constructor.
Constructors
| ModifyCapacityReservationFleetResponse' | |
Fields
| |
Instances
newModifyCapacityReservationFleetResponse Source #
Arguments
| :: Int | |
| -> ModifyCapacityReservationFleetResponse |
Create a value of ModifyCapacityReservationFleetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:return':ModifyCapacityReservationFleetResponse', modifyCapacityReservationFleetResponse_return - Returns true if the request succeeds; otherwise, it returns an error.
$sel:httpStatus:ModifyCapacityReservationFleetResponse', modifyCapacityReservationFleetResponse_httpStatus - The response's http status code.
Response Lenses
modifyCapacityReservationFleetResponse_return :: Lens' ModifyCapacityReservationFleetResponse (Maybe Bool) Source #
Returns true if the request succeeds; otherwise, it returns an error.
modifyCapacityReservationFleetResponse_httpStatus :: Lens' ModifyCapacityReservationFleetResponse Int Source #
The response's http status code.