{-# 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.S3.Types.LifecycleExpiration
-- 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.S3.Types.LifecycleExpiration where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.S3.Internal

-- | Container for the expiration for the lifecycle of the object.
--
-- /See:/ 'newLifecycleExpiration' smart constructor.
data LifecycleExpiration = LifecycleExpiration'
  { -- | Indicates at what date the object is to be moved or deleted. Should be
    -- in GMT ISO 8601 Format.
    LifecycleExpiration -> Maybe ISO8601
date :: Prelude.Maybe Data.ISO8601,
    -- | Indicates the lifetime, in days, of the objects that are subject to the
    -- rule. The value must be a non-zero positive integer.
    LifecycleExpiration -> Maybe Int
days :: Prelude.Maybe Prelude.Int,
    -- | Indicates whether Amazon S3 will remove a delete marker with no
    -- noncurrent versions. If set to true, the delete marker will be expired;
    -- if set to false the policy takes no action. This cannot be specified
    -- with Days or Date in a Lifecycle Expiration Policy.
    LifecycleExpiration -> Maybe Bool
expiredObjectDeleteMarker :: Prelude.Maybe Prelude.Bool
  }
  deriving (LifecycleExpiration -> LifecycleExpiration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LifecycleExpiration -> LifecycleExpiration -> Bool
$c/= :: LifecycleExpiration -> LifecycleExpiration -> Bool
== :: LifecycleExpiration -> LifecycleExpiration -> Bool
$c== :: LifecycleExpiration -> LifecycleExpiration -> Bool
Prelude.Eq, ReadPrec [LifecycleExpiration]
ReadPrec LifecycleExpiration
Int -> ReadS LifecycleExpiration
ReadS [LifecycleExpiration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [LifecycleExpiration]
$creadListPrec :: ReadPrec [LifecycleExpiration]
readPrec :: ReadPrec LifecycleExpiration
$creadPrec :: ReadPrec LifecycleExpiration
readList :: ReadS [LifecycleExpiration]
$creadList :: ReadS [LifecycleExpiration]
readsPrec :: Int -> ReadS LifecycleExpiration
$creadsPrec :: Int -> ReadS LifecycleExpiration
Prelude.Read, Int -> LifecycleExpiration -> ShowS
[LifecycleExpiration] -> ShowS
LifecycleExpiration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LifecycleExpiration] -> ShowS
$cshowList :: [LifecycleExpiration] -> ShowS
show :: LifecycleExpiration -> String
$cshow :: LifecycleExpiration -> String
showsPrec :: Int -> LifecycleExpiration -> ShowS
$cshowsPrec :: Int -> LifecycleExpiration -> ShowS
Prelude.Show, forall x. Rep LifecycleExpiration x -> LifecycleExpiration
forall x. LifecycleExpiration -> Rep LifecycleExpiration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep LifecycleExpiration x -> LifecycleExpiration
$cfrom :: forall x. LifecycleExpiration -> Rep LifecycleExpiration x
Prelude.Generic)

-- |
-- Create a value of 'LifecycleExpiration' 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:
--
-- 'date', 'lifecycleExpiration_date' - Indicates at what date the object is to be moved or deleted. Should be
-- in GMT ISO 8601 Format.
--
-- 'days', 'lifecycleExpiration_days' - Indicates the lifetime, in days, of the objects that are subject to the
-- rule. The value must be a non-zero positive integer.
--
-- 'expiredObjectDeleteMarker', 'lifecycleExpiration_expiredObjectDeleteMarker' - Indicates whether Amazon S3 will remove a delete marker with no
-- noncurrent versions. If set to true, the delete marker will be expired;
-- if set to false the policy takes no action. This cannot be specified
-- with Days or Date in a Lifecycle Expiration Policy.
newLifecycleExpiration ::
  LifecycleExpiration
newLifecycleExpiration :: LifecycleExpiration
newLifecycleExpiration =
  LifecycleExpiration'
    { $sel:date:LifecycleExpiration' :: Maybe ISO8601
date = forall a. Maybe a
Prelude.Nothing,
      $sel:days:LifecycleExpiration' :: Maybe Int
days = forall a. Maybe a
Prelude.Nothing,
      $sel:expiredObjectDeleteMarker:LifecycleExpiration' :: Maybe Bool
expiredObjectDeleteMarker = forall a. Maybe a
Prelude.Nothing
    }

-- | Indicates at what date the object is to be moved or deleted. Should be
-- in GMT ISO 8601 Format.
lifecycleExpiration_date :: Lens.Lens' LifecycleExpiration (Prelude.Maybe Prelude.UTCTime)
lifecycleExpiration_date :: Lens' LifecycleExpiration (Maybe UTCTime)
lifecycleExpiration_date = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LifecycleExpiration' {Maybe ISO8601
date :: Maybe ISO8601
$sel:date:LifecycleExpiration' :: LifecycleExpiration -> Maybe ISO8601
date} -> Maybe ISO8601
date) (\s :: LifecycleExpiration
s@LifecycleExpiration' {} Maybe ISO8601
a -> LifecycleExpiration
s {$sel:date:LifecycleExpiration' :: Maybe ISO8601
date = Maybe ISO8601
a} :: LifecycleExpiration) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | Indicates the lifetime, in days, of the objects that are subject to the
-- rule. The value must be a non-zero positive integer.
lifecycleExpiration_days :: Lens.Lens' LifecycleExpiration (Prelude.Maybe Prelude.Int)
lifecycleExpiration_days :: Lens' LifecycleExpiration (Maybe Int)
lifecycleExpiration_days = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LifecycleExpiration' {Maybe Int
days :: Maybe Int
$sel:days:LifecycleExpiration' :: LifecycleExpiration -> Maybe Int
days} -> Maybe Int
days) (\s :: LifecycleExpiration
s@LifecycleExpiration' {} Maybe Int
a -> LifecycleExpiration
s {$sel:days:LifecycleExpiration' :: Maybe Int
days = Maybe Int
a} :: LifecycleExpiration)

-- | Indicates whether Amazon S3 will remove a delete marker with no
-- noncurrent versions. If set to true, the delete marker will be expired;
-- if set to false the policy takes no action. This cannot be specified
-- with Days or Date in a Lifecycle Expiration Policy.
lifecycleExpiration_expiredObjectDeleteMarker :: Lens.Lens' LifecycleExpiration (Prelude.Maybe Prelude.Bool)
lifecycleExpiration_expiredObjectDeleteMarker :: Lens' LifecycleExpiration (Maybe Bool)
lifecycleExpiration_expiredObjectDeleteMarker = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LifecycleExpiration' {Maybe Bool
expiredObjectDeleteMarker :: Maybe Bool
$sel:expiredObjectDeleteMarker:LifecycleExpiration' :: LifecycleExpiration -> Maybe Bool
expiredObjectDeleteMarker} -> Maybe Bool
expiredObjectDeleteMarker) (\s :: LifecycleExpiration
s@LifecycleExpiration' {} Maybe Bool
a -> LifecycleExpiration
s {$sel:expiredObjectDeleteMarker:LifecycleExpiration' :: Maybe Bool
expiredObjectDeleteMarker = Maybe Bool
a} :: LifecycleExpiration)

instance Data.FromXML LifecycleExpiration where
  parseXML :: [Node] -> Either String LifecycleExpiration
parseXML [Node]
x =
    Maybe ISO8601 -> Maybe Int -> Maybe Bool -> LifecycleExpiration
LifecycleExpiration'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Date")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Days")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"ExpiredObjectDeleteMarker")

instance Prelude.Hashable LifecycleExpiration where
  hashWithSalt :: Int -> LifecycleExpiration -> Int
hashWithSalt Int
_salt LifecycleExpiration' {Maybe Bool
Maybe Int
Maybe ISO8601
expiredObjectDeleteMarker :: Maybe Bool
days :: Maybe Int
date :: Maybe ISO8601
$sel:expiredObjectDeleteMarker:LifecycleExpiration' :: LifecycleExpiration -> Maybe Bool
$sel:days:LifecycleExpiration' :: LifecycleExpiration -> Maybe Int
$sel:date:LifecycleExpiration' :: LifecycleExpiration -> Maybe ISO8601
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ISO8601
date
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
days
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
expiredObjectDeleteMarker

instance Prelude.NFData LifecycleExpiration where
  rnf :: LifecycleExpiration -> ()
rnf LifecycleExpiration' {Maybe Bool
Maybe Int
Maybe ISO8601
expiredObjectDeleteMarker :: Maybe Bool
days :: Maybe Int
date :: Maybe ISO8601
$sel:expiredObjectDeleteMarker:LifecycleExpiration' :: LifecycleExpiration -> Maybe Bool
$sel:days:LifecycleExpiration' :: LifecycleExpiration -> Maybe Int
$sel:date:LifecycleExpiration' :: LifecycleExpiration -> Maybe ISO8601
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ISO8601
date
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
days
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
expiredObjectDeleteMarker

instance Data.ToXML LifecycleExpiration where
  toXML :: LifecycleExpiration -> XML
toXML LifecycleExpiration' {Maybe Bool
Maybe Int
Maybe ISO8601
expiredObjectDeleteMarker :: Maybe Bool
days :: Maybe Int
date :: Maybe ISO8601
$sel:expiredObjectDeleteMarker:LifecycleExpiration' :: LifecycleExpiration -> Maybe Bool
$sel:days:LifecycleExpiration' :: LifecycleExpiration -> Maybe Int
$sel:date:LifecycleExpiration' :: LifecycleExpiration -> Maybe ISO8601
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ Name
"Date" forall a. ToXML a => Name -> a -> XML
Data.@= Maybe ISO8601
date,
        Name
"Days" forall a. ToXML a => Name -> a -> XML
Data.@= Maybe Int
days,
        Name
"ExpiredObjectDeleteMarker"
          forall a. ToXML a => Name -> a -> XML
Data.@= Maybe Bool
expiredObjectDeleteMarker
      ]