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 |
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
Synopsis
- data CreateCapacityReservationFleet = CreateCapacityReservationFleet' {
- allocationStrategy :: Maybe Text
- clientToken :: Maybe Text
- dryRun :: Maybe Bool
- endDate :: Maybe ISO8601
- instanceMatchCriteria :: Maybe FleetInstanceMatchCriteria
- tagSpecifications :: Maybe [TagSpecification]
- tenancy :: Maybe FleetCapacityReservationTenancy
- instanceTypeSpecifications :: [ReservationFleetInstanceSpecification]
- totalTargetCapacity :: Int
- newCreateCapacityReservationFleet :: Int -> CreateCapacityReservationFleet
- createCapacityReservationFleet_allocationStrategy :: Lens' CreateCapacityReservationFleet (Maybe Text)
- createCapacityReservationFleet_clientToken :: Lens' CreateCapacityReservationFleet (Maybe Text)
- createCapacityReservationFleet_dryRun :: Lens' CreateCapacityReservationFleet (Maybe Bool)
- createCapacityReservationFleet_endDate :: Lens' CreateCapacityReservationFleet (Maybe UTCTime)
- createCapacityReservationFleet_instanceMatchCriteria :: Lens' CreateCapacityReservationFleet (Maybe FleetInstanceMatchCriteria)
- createCapacityReservationFleet_tagSpecifications :: Lens' CreateCapacityReservationFleet (Maybe [TagSpecification])
- createCapacityReservationFleet_tenancy :: Lens' CreateCapacityReservationFleet (Maybe FleetCapacityReservationTenancy)
- createCapacityReservationFleet_instanceTypeSpecifications :: Lens' CreateCapacityReservationFleet [ReservationFleetInstanceSpecification]
- createCapacityReservationFleet_totalTargetCapacity :: Lens' CreateCapacityReservationFleet Int
- data CreateCapacityReservationFleetResponse = CreateCapacityReservationFleetResponse' {
- allocationStrategy :: Maybe Text
- capacityReservationFleetId :: Maybe Text
- createTime :: Maybe ISO8601
- endDate :: Maybe ISO8601
- fleetCapacityReservations :: Maybe [FleetCapacityReservation]
- instanceMatchCriteria :: Maybe FleetInstanceMatchCriteria
- state :: Maybe CapacityReservationFleetState
- tags :: Maybe [Tag]
- tenancy :: Maybe FleetCapacityReservationTenancy
- totalFulfilledCapacity :: Maybe Double
- totalTargetCapacity :: Maybe Int
- httpStatus :: Int
- newCreateCapacityReservationFleetResponse :: Int -> CreateCapacityReservationFleetResponse
- createCapacityReservationFleetResponse_allocationStrategy :: Lens' CreateCapacityReservationFleetResponse (Maybe Text)
- createCapacityReservationFleetResponse_capacityReservationFleetId :: Lens' CreateCapacityReservationFleetResponse (Maybe Text)
- createCapacityReservationFleetResponse_createTime :: Lens' CreateCapacityReservationFleetResponse (Maybe UTCTime)
- createCapacityReservationFleetResponse_endDate :: Lens' CreateCapacityReservationFleetResponse (Maybe UTCTime)
- createCapacityReservationFleetResponse_fleetCapacityReservations :: Lens' CreateCapacityReservationFleetResponse (Maybe [FleetCapacityReservation])
- createCapacityReservationFleetResponse_instanceMatchCriteria :: Lens' CreateCapacityReservationFleetResponse (Maybe FleetInstanceMatchCriteria)
- createCapacityReservationFleetResponse_state :: Lens' CreateCapacityReservationFleetResponse (Maybe CapacityReservationFleetState)
- createCapacityReservationFleetResponse_tags :: Lens' CreateCapacityReservationFleetResponse (Maybe [Tag])
- createCapacityReservationFleetResponse_tenancy :: Lens' CreateCapacityReservationFleetResponse (Maybe FleetCapacityReservationTenancy)
- createCapacityReservationFleetResponse_totalFulfilledCapacity :: Lens' CreateCapacityReservationFleetResponse (Maybe Double)
- createCapacityReservationFleetResponse_totalTargetCapacity :: Lens' CreateCapacityReservationFleetResponse (Maybe Int)
- createCapacityReservationFleetResponse_httpStatus :: Lens' CreateCapacityReservationFleetResponse Int
Creating a Request
data CreateCapacityReservationFleet Source #
See: newCreateCapacityReservationFleet
smart constructor.
CreateCapacityReservationFleet' | |
|
Instances
newCreateCapacityReservationFleet Source #
Create a value of CreateCapacityReservationFleet
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:
CreateCapacityReservationFleet
, createCapacityReservationFleet_allocationStrategy
- The strategy used by the Capacity Reservation Fleet to determine which
of the specified instance types to use. Currently, only the
prioritized
allocation strategy is supported. For more information,
see
Allocation strategy
in the Amazon EC2 User Guide.
Valid values: prioritized
CreateCapacityReservationFleet
, createCapacityReservationFleet_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
Ensure Idempotency.
$sel:dryRun:CreateCapacityReservationFleet'
, createCapacityReservationFleet_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
.
CreateCapacityReservationFleet
, createCapacityReservationFleet_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
.
CreateCapacityReservationFleet
, createCapacityReservationFleet_instanceMatchCriteria
- Indicates the type of instance launches that the Capacity Reservation
Fleet accepts. All Capacity Reservations in the Fleet inherit this
instance matching criteria.
Currently, Capacity Reservation Fleets support open
instance matching
criteria only. This means that instances that have matching attributes
(instance type, platform, and Availability Zone) run in the Capacity
Reservations automatically. Instances do not need to explicitly target a
Capacity Reservation Fleet to use its reserved capacity.
CreateCapacityReservationFleet
, createCapacityReservationFleet_tagSpecifications
- The tags to assign to the Capacity Reservation Fleet. The tags are
automatically assigned to the Capacity Reservations in the Fleet.
CreateCapacityReservationFleet
, createCapacityReservationFleet_tenancy
- Indicates the tenancy of the Capacity Reservation Fleet. All Capacity
Reservations in the Fleet inherit this tenancy. The Capacity Reservation
Fleet can have one of the following tenancy settings:
default
- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
CreateCapacityReservationFleet
, createCapacityReservationFleet_instanceTypeSpecifications
- Information about the instance types for which to reserve the capacity.
CreateCapacityReservationFleet
, createCapacityReservationFleet_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.
Request Lenses
createCapacityReservationFleet_allocationStrategy :: Lens' CreateCapacityReservationFleet (Maybe Text) Source #
The strategy used by the Capacity Reservation Fleet to determine which
of the specified instance types to use. Currently, only the
prioritized
allocation strategy is supported. For more information,
see
Allocation strategy
in the Amazon EC2 User Guide.
Valid values: prioritized
createCapacityReservationFleet_clientToken :: Lens' CreateCapacityReservationFleet (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
createCapacityReservationFleet_dryRun :: Lens' CreateCapacityReservationFleet (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
.
createCapacityReservationFleet_endDate :: Lens' CreateCapacityReservationFleet (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
.
createCapacityReservationFleet_instanceMatchCriteria :: Lens' CreateCapacityReservationFleet (Maybe FleetInstanceMatchCriteria) Source #
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open
instance matching
criteria only. This means that instances that have matching attributes
(instance type, platform, and Availability Zone) run in the Capacity
Reservations automatically. Instances do not need to explicitly target a
Capacity Reservation Fleet to use its reserved capacity.
createCapacityReservationFleet_tagSpecifications :: Lens' CreateCapacityReservationFleet (Maybe [TagSpecification]) Source #
The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
createCapacityReservationFleet_tenancy :: Lens' CreateCapacityReservationFleet (Maybe FleetCapacityReservationTenancy) Source #
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
default
- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
createCapacityReservationFleet_instanceTypeSpecifications :: Lens' CreateCapacityReservationFleet [ReservationFleetInstanceSpecification] Source #
Information about the instance types for which to reserve the capacity.
createCapacityReservationFleet_totalTargetCapacity :: Lens' CreateCapacityReservationFleet 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.
Destructuring the Response
data CreateCapacityReservationFleetResponse Source #
See: newCreateCapacityReservationFleetResponse
smart constructor.
CreateCapacityReservationFleetResponse' | |
|
Instances
newCreateCapacityReservationFleetResponse Source #
Create a value of CreateCapacityReservationFleetResponse
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:
CreateCapacityReservationFleet
, createCapacityReservationFleetResponse_allocationStrategy
- The allocation strategy used by the Capacity Reservation Fleet.
CreateCapacityReservationFleetResponse
, createCapacityReservationFleetResponse_capacityReservationFleetId
- The ID of the Capacity Reservation Fleet.
CreateCapacityReservationFleetResponse
, createCapacityReservationFleetResponse_createTime
- The date and time at which the Capacity Reservation Fleet was created.
CreateCapacityReservationFleet
, createCapacityReservationFleetResponse_endDate
- The date and time at which the Capacity Reservation Fleet expires.
$sel:fleetCapacityReservations:CreateCapacityReservationFleetResponse'
, createCapacityReservationFleetResponse_fleetCapacityReservations
- Information about the individual Capacity Reservations in the Capacity
Reservation Fleet.
CreateCapacityReservationFleet
, createCapacityReservationFleetResponse_instanceMatchCriteria
- The instance matching criteria for the Capacity Reservation Fleet.
CreateCapacityReservationFleetResponse
, createCapacityReservationFleetResponse_state
- The status of the Capacity Reservation Fleet.
CreateCapacityReservationFleetResponse
, createCapacityReservationFleetResponse_tags
- The tags assigned to the Capacity Reservation Fleet.
CreateCapacityReservationFleet
, createCapacityReservationFleetResponse_tenancy
- Indicates the tenancy of Capacity Reservation Fleet.
CreateCapacityReservationFleetResponse
, createCapacityReservationFleetResponse_totalFulfilledCapacity
- The requested capacity units that have been successfully reserved.
CreateCapacityReservationFleet
, createCapacityReservationFleetResponse_totalTargetCapacity
- The total number of capacity units for which the Capacity Reservation
Fleet reserves capacity.
$sel:httpStatus:CreateCapacityReservationFleetResponse'
, createCapacityReservationFleetResponse_httpStatus
- The response's http status code.
Response Lenses
createCapacityReservationFleetResponse_allocationStrategy :: Lens' CreateCapacityReservationFleetResponse (Maybe Text) Source #
The allocation strategy used by the Capacity Reservation Fleet.
createCapacityReservationFleetResponse_capacityReservationFleetId :: Lens' CreateCapacityReservationFleetResponse (Maybe Text) Source #
The ID of the Capacity Reservation Fleet.
createCapacityReservationFleetResponse_createTime :: Lens' CreateCapacityReservationFleetResponse (Maybe UTCTime) Source #
The date and time at which the Capacity Reservation Fleet was created.
createCapacityReservationFleetResponse_endDate :: Lens' CreateCapacityReservationFleetResponse (Maybe UTCTime) Source #
The date and time at which the Capacity Reservation Fleet expires.
createCapacityReservationFleetResponse_fleetCapacityReservations :: Lens' CreateCapacityReservationFleetResponse (Maybe [FleetCapacityReservation]) Source #
Information about the individual Capacity Reservations in the Capacity Reservation Fleet.
createCapacityReservationFleetResponse_instanceMatchCriteria :: Lens' CreateCapacityReservationFleetResponse (Maybe FleetInstanceMatchCriteria) Source #
The instance matching criteria for the Capacity Reservation Fleet.
createCapacityReservationFleetResponse_state :: Lens' CreateCapacityReservationFleetResponse (Maybe CapacityReservationFleetState) Source #
The status of the Capacity Reservation Fleet.
createCapacityReservationFleetResponse_tags :: Lens' CreateCapacityReservationFleetResponse (Maybe [Tag]) Source #
The tags assigned to the Capacity Reservation Fleet.
createCapacityReservationFleetResponse_tenancy :: Lens' CreateCapacityReservationFleetResponse (Maybe FleetCapacityReservationTenancy) Source #
Indicates the tenancy of Capacity Reservation Fleet.
createCapacityReservationFleetResponse_totalFulfilledCapacity :: Lens' CreateCapacityReservationFleetResponse (Maybe Double) Source #
The requested capacity units that have been successfully reserved.
createCapacityReservationFleetResponse_totalTargetCapacity :: Lens' CreateCapacityReservationFleetResponse (Maybe Int) Source #
The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.
createCapacityReservationFleetResponse_httpStatus :: Lens' CreateCapacityReservationFleetResponse Int Source #
The response's http status code.