{-# 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.Bucket
-- 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.Bucket 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

-- | In terms of implementation, a Bucket is a resource. An Amazon S3 bucket
-- name is globally unique, and the namespace is shared by all Amazon Web
-- Services accounts.
--
-- /See:/ 'newBucket' smart constructor.
data Bucket = Bucket'
  { -- | Date the bucket was created. This date can change when making changes to
    -- your bucket, such as editing its bucket policy.
    Bucket -> ISO8601
creationDate :: Data.ISO8601,
    -- | The name of the bucket.
    Bucket -> BucketName
name :: BucketName
  }
  deriving (Bucket -> Bucket -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Bucket -> Bucket -> Bool
$c/= :: Bucket -> Bucket -> Bool
== :: Bucket -> Bucket -> Bool
$c== :: Bucket -> Bucket -> Bool
Prelude.Eq, ReadPrec [Bucket]
ReadPrec Bucket
Int -> ReadS Bucket
ReadS [Bucket]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Bucket]
$creadListPrec :: ReadPrec [Bucket]
readPrec :: ReadPrec Bucket
$creadPrec :: ReadPrec Bucket
readList :: ReadS [Bucket]
$creadList :: ReadS [Bucket]
readsPrec :: Int -> ReadS Bucket
$creadsPrec :: Int -> ReadS Bucket
Prelude.Read, Int -> Bucket -> ShowS
[Bucket] -> ShowS
Bucket -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Bucket] -> ShowS
$cshowList :: [Bucket] -> ShowS
show :: Bucket -> String
$cshow :: Bucket -> String
showsPrec :: Int -> Bucket -> ShowS
$cshowsPrec :: Int -> Bucket -> ShowS
Prelude.Show, forall x. Rep Bucket x -> Bucket
forall x. Bucket -> Rep Bucket x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Bucket x -> Bucket
$cfrom :: forall x. Bucket -> Rep Bucket x
Prelude.Generic)

-- |
-- Create a value of 'Bucket' 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:
--
-- 'creationDate', 'bucket_creationDate' - Date the bucket was created. This date can change when making changes to
-- your bucket, such as editing its bucket policy.
--
-- 'name', 'bucket_name' - The name of the bucket.
newBucket ::
  -- | 'creationDate'
  Prelude.UTCTime ->
  -- | 'name'
  BucketName ->
  Bucket
newBucket :: UTCTime -> BucketName -> Bucket
newBucket UTCTime
pCreationDate_ BucketName
pName_ =
  Bucket'
    { $sel:creationDate:Bucket' :: ISO8601
creationDate =
        forall (a :: Format). Iso' (Time a) UTCTime
Data._Time forall t b. AReview t b -> b -> t
Lens.# UTCTime
pCreationDate_,
      $sel:name:Bucket' :: BucketName
name = BucketName
pName_
    }

-- | Date the bucket was created. This date can change when making changes to
-- your bucket, such as editing its bucket policy.
bucket_creationDate :: Lens.Lens' Bucket Prelude.UTCTime
bucket_creationDate :: Lens' Bucket UTCTime
bucket_creationDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Bucket' {ISO8601
creationDate :: ISO8601
$sel:creationDate:Bucket' :: Bucket -> ISO8601
creationDate} -> ISO8601
creationDate) (\s :: Bucket
s@Bucket' {} ISO8601
a -> Bucket
s {$sel:creationDate:Bucket' :: ISO8601
creationDate = ISO8601
a} :: Bucket) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The name of the bucket.
bucket_name :: Lens.Lens' Bucket BucketName
bucket_name :: Lens' Bucket BucketName
bucket_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Bucket' {BucketName
name :: BucketName
$sel:name:Bucket' :: Bucket -> BucketName
name} -> BucketName
name) (\s :: Bucket
s@Bucket' {} BucketName
a -> Bucket
s {$sel:name:Bucket' :: BucketName
name = BucketName
a} :: Bucket)

instance Data.FromXML Bucket where
  parseXML :: [Node] -> Either String Bucket
parseXML [Node]
x =
    ISO8601 -> BucketName -> Bucket
Bucket'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"CreationDate")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"Name")

instance Prelude.Hashable Bucket where
  hashWithSalt :: Int -> Bucket -> Int
hashWithSalt Int
_salt Bucket' {ISO8601
BucketName
name :: BucketName
creationDate :: ISO8601
$sel:name:Bucket' :: Bucket -> BucketName
$sel:creationDate:Bucket' :: Bucket -> ISO8601
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ISO8601
creationDate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` BucketName
name

instance Prelude.NFData Bucket where
  rnf :: Bucket -> ()
rnf Bucket' {ISO8601
BucketName
name :: BucketName
creationDate :: ISO8601
$sel:name:Bucket' :: Bucket -> BucketName
$sel:creationDate:Bucket' :: Bucket -> ISO8601
..} =
    forall a. NFData a => a -> ()
Prelude.rnf ISO8601
creationDate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf BucketName
name