{-# 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.ScheduledInstanceRecurrenceRequest
-- 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.ScheduledInstanceRecurrenceRequest 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 qualified Amazonka.Prelude as Prelude

-- | Describes the recurring schedule for a Scheduled Instance.
--
-- /See:/ 'newScheduledInstanceRecurrenceRequest' smart constructor.
data ScheduledInstanceRecurrenceRequest = ScheduledInstanceRecurrenceRequest'
  { -- | The frequency (@Daily@, @Weekly@, or @Monthly@).
    ScheduledInstanceRecurrenceRequest -> Maybe Text
frequency :: Prelude.Maybe Prelude.Text,
    -- | The interval quantity. The interval unit depends on the value of
    -- @Frequency@. For example, every 2 weeks or every 2 months.
    ScheduledInstanceRecurrenceRequest -> Maybe Int
interval :: Prelude.Maybe Prelude.Int,
    -- | The days. For a monthly schedule, this is one or more days of the month
    -- (1-31). For a weekly schedule, this is one or more days of the week
    -- (1-7, where 1 is Sunday). You can\'t specify this value with a daily
    -- schedule. If the occurrence is relative to the end of the month, you can
    -- specify only a single day.
    ScheduledInstanceRecurrenceRequest -> Maybe [Int]
occurrenceDays :: Prelude.Maybe [Prelude.Int],
    -- | Indicates whether the occurrence is relative to the end of the specified
    -- week or month. You can\'t specify this value with a daily schedule.
    ScheduledInstanceRecurrenceRequest -> Maybe Bool
occurrenceRelativeToEnd :: Prelude.Maybe Prelude.Bool,
    -- | The unit for @OccurrenceDays@ (@DayOfWeek@ or @DayOfMonth@). This value
    -- is required for a monthly schedule. You can\'t specify @DayOfWeek@ with
    -- a weekly schedule. You can\'t specify this value with a daily schedule.
    ScheduledInstanceRecurrenceRequest -> Maybe Text
occurrenceUnit :: Prelude.Maybe Prelude.Text
  }
  deriving (ScheduledInstanceRecurrenceRequest
-> ScheduledInstanceRecurrenceRequest -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ScheduledInstanceRecurrenceRequest
-> ScheduledInstanceRecurrenceRequest -> Bool
$c/= :: ScheduledInstanceRecurrenceRequest
-> ScheduledInstanceRecurrenceRequest -> Bool
== :: ScheduledInstanceRecurrenceRequest
-> ScheduledInstanceRecurrenceRequest -> Bool
$c== :: ScheduledInstanceRecurrenceRequest
-> ScheduledInstanceRecurrenceRequest -> Bool
Prelude.Eq, ReadPrec [ScheduledInstanceRecurrenceRequest]
ReadPrec ScheduledInstanceRecurrenceRequest
Int -> ReadS ScheduledInstanceRecurrenceRequest
ReadS [ScheduledInstanceRecurrenceRequest]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ScheduledInstanceRecurrenceRequest]
$creadListPrec :: ReadPrec [ScheduledInstanceRecurrenceRequest]
readPrec :: ReadPrec ScheduledInstanceRecurrenceRequest
$creadPrec :: ReadPrec ScheduledInstanceRecurrenceRequest
readList :: ReadS [ScheduledInstanceRecurrenceRequest]
$creadList :: ReadS [ScheduledInstanceRecurrenceRequest]
readsPrec :: Int -> ReadS ScheduledInstanceRecurrenceRequest
$creadsPrec :: Int -> ReadS ScheduledInstanceRecurrenceRequest
Prelude.Read, Int -> ScheduledInstanceRecurrenceRequest -> ShowS
[ScheduledInstanceRecurrenceRequest] -> ShowS
ScheduledInstanceRecurrenceRequest -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ScheduledInstanceRecurrenceRequest] -> ShowS
$cshowList :: [ScheduledInstanceRecurrenceRequest] -> ShowS
show :: ScheduledInstanceRecurrenceRequest -> String
$cshow :: ScheduledInstanceRecurrenceRequest -> String
showsPrec :: Int -> ScheduledInstanceRecurrenceRequest -> ShowS
$cshowsPrec :: Int -> ScheduledInstanceRecurrenceRequest -> ShowS
Prelude.Show, forall x.
Rep ScheduledInstanceRecurrenceRequest x
-> ScheduledInstanceRecurrenceRequest
forall x.
ScheduledInstanceRecurrenceRequest
-> Rep ScheduledInstanceRecurrenceRequest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ScheduledInstanceRecurrenceRequest x
-> ScheduledInstanceRecurrenceRequest
$cfrom :: forall x.
ScheduledInstanceRecurrenceRequest
-> Rep ScheduledInstanceRecurrenceRequest x
Prelude.Generic)

-- |
-- Create a value of 'ScheduledInstanceRecurrenceRequest' 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:
--
-- 'frequency', 'scheduledInstanceRecurrenceRequest_frequency' - The frequency (@Daily@, @Weekly@, or @Monthly@).
--
-- 'interval', 'scheduledInstanceRecurrenceRequest_interval' - The interval quantity. The interval unit depends on the value of
-- @Frequency@. For example, every 2 weeks or every 2 months.
--
-- 'occurrenceDays', 'scheduledInstanceRecurrenceRequest_occurrenceDays' - The days. For a monthly schedule, this is one or more days of the month
-- (1-31). For a weekly schedule, this is one or more days of the week
-- (1-7, where 1 is Sunday). You can\'t specify this value with a daily
-- schedule. If the occurrence is relative to the end of the month, you can
-- specify only a single day.
--
-- 'occurrenceRelativeToEnd', 'scheduledInstanceRecurrenceRequest_occurrenceRelativeToEnd' - Indicates whether the occurrence is relative to the end of the specified
-- week or month. You can\'t specify this value with a daily schedule.
--
-- 'occurrenceUnit', 'scheduledInstanceRecurrenceRequest_occurrenceUnit' - The unit for @OccurrenceDays@ (@DayOfWeek@ or @DayOfMonth@). This value
-- is required for a monthly schedule. You can\'t specify @DayOfWeek@ with
-- a weekly schedule. You can\'t specify this value with a daily schedule.
newScheduledInstanceRecurrenceRequest ::
  ScheduledInstanceRecurrenceRequest
newScheduledInstanceRecurrenceRequest :: ScheduledInstanceRecurrenceRequest
newScheduledInstanceRecurrenceRequest =
  ScheduledInstanceRecurrenceRequest'
    { $sel:frequency:ScheduledInstanceRecurrenceRequest' :: Maybe Text
frequency =
        forall a. Maybe a
Prelude.Nothing,
      $sel:interval:ScheduledInstanceRecurrenceRequest' :: Maybe Int
interval = forall a. Maybe a
Prelude.Nothing,
      $sel:occurrenceDays:ScheduledInstanceRecurrenceRequest' :: Maybe [Int]
occurrenceDays = forall a. Maybe a
Prelude.Nothing,
      $sel:occurrenceRelativeToEnd:ScheduledInstanceRecurrenceRequest' :: Maybe Bool
occurrenceRelativeToEnd =
        forall a. Maybe a
Prelude.Nothing,
      $sel:occurrenceUnit:ScheduledInstanceRecurrenceRequest' :: Maybe Text
occurrenceUnit = forall a. Maybe a
Prelude.Nothing
    }

-- | The frequency (@Daily@, @Weekly@, or @Monthly@).
scheduledInstanceRecurrenceRequest_frequency :: Lens.Lens' ScheduledInstanceRecurrenceRequest (Prelude.Maybe Prelude.Text)
scheduledInstanceRecurrenceRequest_frequency :: Lens' ScheduledInstanceRecurrenceRequest (Maybe Text)
scheduledInstanceRecurrenceRequest_frequency = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScheduledInstanceRecurrenceRequest' {Maybe Text
frequency :: Maybe Text
$sel:frequency:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
frequency} -> Maybe Text
frequency) (\s :: ScheduledInstanceRecurrenceRequest
s@ScheduledInstanceRecurrenceRequest' {} Maybe Text
a -> ScheduledInstanceRecurrenceRequest
s {$sel:frequency:ScheduledInstanceRecurrenceRequest' :: Maybe Text
frequency = Maybe Text
a} :: ScheduledInstanceRecurrenceRequest)

-- | The interval quantity. The interval unit depends on the value of
-- @Frequency@. For example, every 2 weeks or every 2 months.
scheduledInstanceRecurrenceRequest_interval :: Lens.Lens' ScheduledInstanceRecurrenceRequest (Prelude.Maybe Prelude.Int)
scheduledInstanceRecurrenceRequest_interval :: Lens' ScheduledInstanceRecurrenceRequest (Maybe Int)
scheduledInstanceRecurrenceRequest_interval = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScheduledInstanceRecurrenceRequest' {Maybe Int
interval :: Maybe Int
$sel:interval:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Int
interval} -> Maybe Int
interval) (\s :: ScheduledInstanceRecurrenceRequest
s@ScheduledInstanceRecurrenceRequest' {} Maybe Int
a -> ScheduledInstanceRecurrenceRequest
s {$sel:interval:ScheduledInstanceRecurrenceRequest' :: Maybe Int
interval = Maybe Int
a} :: ScheduledInstanceRecurrenceRequest)

-- | The days. For a monthly schedule, this is one or more days of the month
-- (1-31). For a weekly schedule, this is one or more days of the week
-- (1-7, where 1 is Sunday). You can\'t specify this value with a daily
-- schedule. If the occurrence is relative to the end of the month, you can
-- specify only a single day.
scheduledInstanceRecurrenceRequest_occurrenceDays :: Lens.Lens' ScheduledInstanceRecurrenceRequest (Prelude.Maybe [Prelude.Int])
scheduledInstanceRecurrenceRequest_occurrenceDays :: Lens' ScheduledInstanceRecurrenceRequest (Maybe [Int])
scheduledInstanceRecurrenceRequest_occurrenceDays = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScheduledInstanceRecurrenceRequest' {Maybe [Int]
occurrenceDays :: Maybe [Int]
$sel:occurrenceDays:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe [Int]
occurrenceDays} -> Maybe [Int]
occurrenceDays) (\s :: ScheduledInstanceRecurrenceRequest
s@ScheduledInstanceRecurrenceRequest' {} Maybe [Int]
a -> ScheduledInstanceRecurrenceRequest
s {$sel:occurrenceDays:ScheduledInstanceRecurrenceRequest' :: Maybe [Int]
occurrenceDays = Maybe [Int]
a} :: ScheduledInstanceRecurrenceRequest) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Indicates whether the occurrence is relative to the end of the specified
-- week or month. You can\'t specify this value with a daily schedule.
scheduledInstanceRecurrenceRequest_occurrenceRelativeToEnd :: Lens.Lens' ScheduledInstanceRecurrenceRequest (Prelude.Maybe Prelude.Bool)
scheduledInstanceRecurrenceRequest_occurrenceRelativeToEnd :: Lens' ScheduledInstanceRecurrenceRequest (Maybe Bool)
scheduledInstanceRecurrenceRequest_occurrenceRelativeToEnd = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScheduledInstanceRecurrenceRequest' {Maybe Bool
occurrenceRelativeToEnd :: Maybe Bool
$sel:occurrenceRelativeToEnd:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Bool
occurrenceRelativeToEnd} -> Maybe Bool
occurrenceRelativeToEnd) (\s :: ScheduledInstanceRecurrenceRequest
s@ScheduledInstanceRecurrenceRequest' {} Maybe Bool
a -> ScheduledInstanceRecurrenceRequest
s {$sel:occurrenceRelativeToEnd:ScheduledInstanceRecurrenceRequest' :: Maybe Bool
occurrenceRelativeToEnd = Maybe Bool
a} :: ScheduledInstanceRecurrenceRequest)

-- | The unit for @OccurrenceDays@ (@DayOfWeek@ or @DayOfMonth@). This value
-- is required for a monthly schedule. You can\'t specify @DayOfWeek@ with
-- a weekly schedule. You can\'t specify this value with a daily schedule.
scheduledInstanceRecurrenceRequest_occurrenceUnit :: Lens.Lens' ScheduledInstanceRecurrenceRequest (Prelude.Maybe Prelude.Text)
scheduledInstanceRecurrenceRequest_occurrenceUnit :: Lens' ScheduledInstanceRecurrenceRequest (Maybe Text)
scheduledInstanceRecurrenceRequest_occurrenceUnit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScheduledInstanceRecurrenceRequest' {Maybe Text
occurrenceUnit :: Maybe Text
$sel:occurrenceUnit:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
occurrenceUnit} -> Maybe Text
occurrenceUnit) (\s :: ScheduledInstanceRecurrenceRequest
s@ScheduledInstanceRecurrenceRequest' {} Maybe Text
a -> ScheduledInstanceRecurrenceRequest
s {$sel:occurrenceUnit:ScheduledInstanceRecurrenceRequest' :: Maybe Text
occurrenceUnit = Maybe Text
a} :: ScheduledInstanceRecurrenceRequest)

instance
  Prelude.Hashable
    ScheduledInstanceRecurrenceRequest
  where
  hashWithSalt :: Int -> ScheduledInstanceRecurrenceRequest -> Int
hashWithSalt
    Int
_salt
    ScheduledInstanceRecurrenceRequest' {Maybe Bool
Maybe Int
Maybe [Int]
Maybe Text
occurrenceUnit :: Maybe Text
occurrenceRelativeToEnd :: Maybe Bool
occurrenceDays :: Maybe [Int]
interval :: Maybe Int
frequency :: Maybe Text
$sel:occurrenceUnit:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
$sel:occurrenceRelativeToEnd:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Bool
$sel:occurrenceDays:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe [Int]
$sel:interval:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Int
$sel:frequency:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
frequency
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
interval
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Int]
occurrenceDays
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
occurrenceRelativeToEnd
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
occurrenceUnit

instance
  Prelude.NFData
    ScheduledInstanceRecurrenceRequest
  where
  rnf :: ScheduledInstanceRecurrenceRequest -> ()
rnf ScheduledInstanceRecurrenceRequest' {Maybe Bool
Maybe Int
Maybe [Int]
Maybe Text
occurrenceUnit :: Maybe Text
occurrenceRelativeToEnd :: Maybe Bool
occurrenceDays :: Maybe [Int]
interval :: Maybe Int
frequency :: Maybe Text
$sel:occurrenceUnit:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
$sel:occurrenceRelativeToEnd:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Bool
$sel:occurrenceDays:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe [Int]
$sel:interval:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Int
$sel:frequency:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
frequency
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
interval
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Int]
occurrenceDays
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
occurrenceRelativeToEnd
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
occurrenceUnit

instance
  Data.ToQuery
    ScheduledInstanceRecurrenceRequest
  where
  toQuery :: ScheduledInstanceRecurrenceRequest -> QueryString
toQuery ScheduledInstanceRecurrenceRequest' {Maybe Bool
Maybe Int
Maybe [Int]
Maybe Text
occurrenceUnit :: Maybe Text
occurrenceRelativeToEnd :: Maybe Bool
occurrenceDays :: Maybe [Int]
interval :: Maybe Int
frequency :: Maybe Text
$sel:occurrenceUnit:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
$sel:occurrenceRelativeToEnd:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Bool
$sel:occurrenceDays:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe [Int]
$sel:interval:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Int
$sel:frequency:ScheduledInstanceRecurrenceRequest' :: ScheduledInstanceRecurrenceRequest -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Frequency" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
frequency,
        ByteString
"Interval" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Int
interval,
        forall a. ToQuery a => a -> QueryString
Data.toQuery
          ( forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"OccurrenceDay"
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Int]
occurrenceDays
          ),
        ByteString
"OccurrenceRelativeToEnd"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Bool
occurrenceRelativeToEnd,
        ByteString
"OccurrenceUnit" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
occurrenceUnit
      ]