{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.EC2.Types.CapacityReservationOptionsRequest
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.EC2.Types.CapacityReservationOptionsRequest where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.EC2.Internal
import Amazonka.EC2.Types.FleetCapacityReservationUsageStrategy
import qualified Amazonka.Prelude as Prelude

-- | Describes the strategy for using unused Capacity Reservations for
-- fulfilling On-Demand capacity.
--
-- This strategy can only be used if the EC2 Fleet is of type @instant@.
--
-- For more information about Capacity Reservations, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html On-Demand Capacity Reservations>
-- in the /Amazon EC2 User Guide/. For examples of using Capacity
-- Reservations in an EC2 Fleet, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html EC2 Fleet example configurations>
-- in the /Amazon EC2 User Guide/.
--
-- /See:/ 'newCapacityReservationOptionsRequest' smart constructor.
data CapacityReservationOptionsRequest = CapacityReservationOptionsRequest'
  { -- | Indicates whether to use unused Capacity Reservations for fulfilling
    -- On-Demand capacity.
    --
    -- If you specify @use-capacity-reservations-first@, the fleet uses unused
    -- Capacity Reservations to fulfill On-Demand capacity up to the target
    -- On-Demand capacity. If multiple instance pools have unused Capacity
    -- Reservations, the On-Demand allocation strategy (@lowest-price@ or
    -- @prioritized@) is applied. If the number of unused Capacity Reservations
    -- is less than the On-Demand target capacity, the remaining On-Demand
    -- target capacity is launched according to the On-Demand allocation
    -- strategy (@lowest-price@ or @prioritized@).
    --
    -- If you do not specify a value, the fleet fulfils the On-Demand capacity
    -- according to the chosen On-Demand allocation strategy.
    CapacityReservationOptionsRequest
-> Maybe FleetCapacityReservationUsageStrategy
usageStrategy :: Prelude.Maybe FleetCapacityReservationUsageStrategy
  }
  deriving (CapacityReservationOptionsRequest
-> CapacityReservationOptionsRequest -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CapacityReservationOptionsRequest
-> CapacityReservationOptionsRequest -> Bool
$c/= :: CapacityReservationOptionsRequest
-> CapacityReservationOptionsRequest -> Bool
== :: CapacityReservationOptionsRequest
-> CapacityReservationOptionsRequest -> Bool
$c== :: CapacityReservationOptionsRequest
-> CapacityReservationOptionsRequest -> Bool
Prelude.Eq, ReadPrec [CapacityReservationOptionsRequest]
ReadPrec CapacityReservationOptionsRequest
Int -> ReadS CapacityReservationOptionsRequest
ReadS [CapacityReservationOptionsRequest]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CapacityReservationOptionsRequest]
$creadListPrec :: ReadPrec [CapacityReservationOptionsRequest]
readPrec :: ReadPrec CapacityReservationOptionsRequest
$creadPrec :: ReadPrec CapacityReservationOptionsRequest
readList :: ReadS [CapacityReservationOptionsRequest]
$creadList :: ReadS [CapacityReservationOptionsRequest]
readsPrec :: Int -> ReadS CapacityReservationOptionsRequest
$creadsPrec :: Int -> ReadS CapacityReservationOptionsRequest
Prelude.Read, Int -> CapacityReservationOptionsRequest -> ShowS
[CapacityReservationOptionsRequest] -> ShowS
CapacityReservationOptionsRequest -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CapacityReservationOptionsRequest] -> ShowS
$cshowList :: [CapacityReservationOptionsRequest] -> ShowS
show :: CapacityReservationOptionsRequest -> String
$cshow :: CapacityReservationOptionsRequest -> String
showsPrec :: Int -> CapacityReservationOptionsRequest -> ShowS
$cshowsPrec :: Int -> CapacityReservationOptionsRequest -> ShowS
Prelude.Show, forall x.
Rep CapacityReservationOptionsRequest x
-> CapacityReservationOptionsRequest
forall x.
CapacityReservationOptionsRequest
-> Rep CapacityReservationOptionsRequest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CapacityReservationOptionsRequest x
-> CapacityReservationOptionsRequest
$cfrom :: forall x.
CapacityReservationOptionsRequest
-> Rep CapacityReservationOptionsRequest x
Prelude.Generic)

-- |
-- Create a value of 'CapacityReservationOptionsRequest' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'usageStrategy', 'capacityReservationOptionsRequest_usageStrategy' - Indicates whether to use unused Capacity Reservations for fulfilling
-- On-Demand capacity.
--
-- If you specify @use-capacity-reservations-first@, the fleet uses unused
-- Capacity Reservations to fulfill On-Demand capacity up to the target
-- On-Demand capacity. If multiple instance pools have unused Capacity
-- Reservations, the On-Demand allocation strategy (@lowest-price@ or
-- @prioritized@) is applied. If the number of unused Capacity Reservations
-- is less than the On-Demand target capacity, the remaining On-Demand
-- target capacity is launched according to the On-Demand allocation
-- strategy (@lowest-price@ or @prioritized@).
--
-- If you do not specify a value, the fleet fulfils the On-Demand capacity
-- according to the chosen On-Demand allocation strategy.
newCapacityReservationOptionsRequest ::
  CapacityReservationOptionsRequest
newCapacityReservationOptionsRequest :: CapacityReservationOptionsRequest
newCapacityReservationOptionsRequest =
  CapacityReservationOptionsRequest'
    { $sel:usageStrategy:CapacityReservationOptionsRequest' :: Maybe FleetCapacityReservationUsageStrategy
usageStrategy =
        forall a. Maybe a
Prelude.Nothing
    }

-- | Indicates whether to use unused Capacity Reservations for fulfilling
-- On-Demand capacity.
--
-- If you specify @use-capacity-reservations-first@, the fleet uses unused
-- Capacity Reservations to fulfill On-Demand capacity up to the target
-- On-Demand capacity. If multiple instance pools have unused Capacity
-- Reservations, the On-Demand allocation strategy (@lowest-price@ or
-- @prioritized@) is applied. If the number of unused Capacity Reservations
-- is less than the On-Demand target capacity, the remaining On-Demand
-- target capacity is launched according to the On-Demand allocation
-- strategy (@lowest-price@ or @prioritized@).
--
-- If you do not specify a value, the fleet fulfils the On-Demand capacity
-- according to the chosen On-Demand allocation strategy.
capacityReservationOptionsRequest_usageStrategy :: Lens.Lens' CapacityReservationOptionsRequest (Prelude.Maybe FleetCapacityReservationUsageStrategy)
capacityReservationOptionsRequest_usageStrategy :: Lens'
  CapacityReservationOptionsRequest
  (Maybe FleetCapacityReservationUsageStrategy)
capacityReservationOptionsRequest_usageStrategy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CapacityReservationOptionsRequest' {Maybe FleetCapacityReservationUsageStrategy
usageStrategy :: Maybe FleetCapacityReservationUsageStrategy
$sel:usageStrategy:CapacityReservationOptionsRequest' :: CapacityReservationOptionsRequest
-> Maybe FleetCapacityReservationUsageStrategy
usageStrategy} -> Maybe FleetCapacityReservationUsageStrategy
usageStrategy) (\s :: CapacityReservationOptionsRequest
s@CapacityReservationOptionsRequest' {} Maybe FleetCapacityReservationUsageStrategy
a -> CapacityReservationOptionsRequest
s {$sel:usageStrategy:CapacityReservationOptionsRequest' :: Maybe FleetCapacityReservationUsageStrategy
usageStrategy = Maybe FleetCapacityReservationUsageStrategy
a} :: CapacityReservationOptionsRequest)

instance
  Prelude.Hashable
    CapacityReservationOptionsRequest
  where
  hashWithSalt :: Int -> CapacityReservationOptionsRequest -> Int
hashWithSalt
    Int
_salt
    CapacityReservationOptionsRequest' {Maybe FleetCapacityReservationUsageStrategy
usageStrategy :: Maybe FleetCapacityReservationUsageStrategy
$sel:usageStrategy:CapacityReservationOptionsRequest' :: CapacityReservationOptionsRequest
-> Maybe FleetCapacityReservationUsageStrategy
..} =
      Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FleetCapacityReservationUsageStrategy
usageStrategy

instance
  Prelude.NFData
    CapacityReservationOptionsRequest
  where
  rnf :: CapacityReservationOptionsRequest -> ()
rnf CapacityReservationOptionsRequest' {Maybe FleetCapacityReservationUsageStrategy
usageStrategy :: Maybe FleetCapacityReservationUsageStrategy
$sel:usageStrategy:CapacityReservationOptionsRequest' :: CapacityReservationOptionsRequest
-> Maybe FleetCapacityReservationUsageStrategy
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe FleetCapacityReservationUsageStrategy
usageStrategy

instance
  Data.ToQuery
    CapacityReservationOptionsRequest
  where
  toQuery :: CapacityReservationOptionsRequest -> QueryString
toQuery CapacityReservationOptionsRequest' {Maybe FleetCapacityReservationUsageStrategy
usageStrategy :: Maybe FleetCapacityReservationUsageStrategy
$sel:usageStrategy:CapacityReservationOptionsRequest' :: CapacityReservationOptionsRequest
-> Maybe FleetCapacityReservationUsageStrategy
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"UsageStrategy" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe FleetCapacityReservationUsageStrategy
usageStrategy]