{-# 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.Lightsail.Types.CacheBehaviorPerPath
-- 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.Lightsail.Types.CacheBehaviorPerPath where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Lightsail.Types.BehaviorEnum
import qualified Amazonka.Prelude as Prelude

-- | Describes the per-path cache behavior of an Amazon Lightsail content
-- delivery network (CDN) distribution.
--
-- A per-path cache behavior is used to override, or add an exception to,
-- the default cache behavior of a distribution. For example, if the
-- @cacheBehavior@ is set to @cache@, then a per-path cache behavior can be
-- used to specify a directory, file, or file type that your distribution
-- will cache. Alternately, if the distribution\'s @cacheBehavior@ is
-- @dont-cache@, then a per-path cache behavior can be used to specify a
-- directory, file, or file type that your distribution will not cache.
--
-- /See:/ 'newCacheBehaviorPerPath' smart constructor.
data CacheBehaviorPerPath = CacheBehaviorPerPath'
  { -- | The cache behavior for the specified path.
    --
    -- You can specify one of the following per-path cache behaviors:
    --
    -- -   __@cache@__ - This behavior caches the specified path.
    --
    -- -   __@dont-cache@__ - This behavior doesn\'t cache the specified path.
    CacheBehaviorPerPath -> Maybe BehaviorEnum
behavior :: Prelude.Maybe BehaviorEnum,
    -- | The path to a directory or file to cached, or not cache. Use an asterisk
    -- symbol to specify wildcard directories (@path\/to\/assets\/*@), and file
    -- types (@*.html, *jpg, *js@). Directories and file paths are
    -- case-sensitive.
    --
    -- Examples:
    --
    -- -   Specify the following to cache all files in the document root of an
    --     Apache web server running on a Lightsail instance.
    --
    --     @var\/www\/html\/@
    --
    -- -   Specify the following file to cache only the index page in the
    --     document root of an Apache web server.
    --
    --     @var\/www\/html\/index.html@
    --
    -- -   Specify the following to cache only the .html files in the document
    --     root of an Apache web server.
    --
    --     @var\/www\/html\/*.html@
    --
    -- -   Specify the following to cache only the .jpg, .png, and .gif files
    --     in the images sub-directory of the document root of an Apache web
    --     server.
    --
    --     @var\/www\/html\/images\/*.jpg@
    --
    --     @var\/www\/html\/images\/*.png@
    --
    --     @var\/www\/html\/images\/*.gif@
    --
    --     Specify the following to cache all files in the images sub-directory
    --     of the document root of an Apache web server.
    --
    --     @var\/www\/html\/images\/@
    CacheBehaviorPerPath -> Maybe Text
path :: Prelude.Maybe Prelude.Text
  }
  deriving (CacheBehaviorPerPath -> CacheBehaviorPerPath -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CacheBehaviorPerPath -> CacheBehaviorPerPath -> Bool
$c/= :: CacheBehaviorPerPath -> CacheBehaviorPerPath -> Bool
== :: CacheBehaviorPerPath -> CacheBehaviorPerPath -> Bool
$c== :: CacheBehaviorPerPath -> CacheBehaviorPerPath -> Bool
Prelude.Eq, ReadPrec [CacheBehaviorPerPath]
ReadPrec CacheBehaviorPerPath
Int -> ReadS CacheBehaviorPerPath
ReadS [CacheBehaviorPerPath]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CacheBehaviorPerPath]
$creadListPrec :: ReadPrec [CacheBehaviorPerPath]
readPrec :: ReadPrec CacheBehaviorPerPath
$creadPrec :: ReadPrec CacheBehaviorPerPath
readList :: ReadS [CacheBehaviorPerPath]
$creadList :: ReadS [CacheBehaviorPerPath]
readsPrec :: Int -> ReadS CacheBehaviorPerPath
$creadsPrec :: Int -> ReadS CacheBehaviorPerPath
Prelude.Read, Int -> CacheBehaviorPerPath -> ShowS
[CacheBehaviorPerPath] -> ShowS
CacheBehaviorPerPath -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CacheBehaviorPerPath] -> ShowS
$cshowList :: [CacheBehaviorPerPath] -> ShowS
show :: CacheBehaviorPerPath -> String
$cshow :: CacheBehaviorPerPath -> String
showsPrec :: Int -> CacheBehaviorPerPath -> ShowS
$cshowsPrec :: Int -> CacheBehaviorPerPath -> ShowS
Prelude.Show, forall x. Rep CacheBehaviorPerPath x -> CacheBehaviorPerPath
forall x. CacheBehaviorPerPath -> Rep CacheBehaviorPerPath x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CacheBehaviorPerPath x -> CacheBehaviorPerPath
$cfrom :: forall x. CacheBehaviorPerPath -> Rep CacheBehaviorPerPath x
Prelude.Generic)

-- |
-- Create a value of 'CacheBehaviorPerPath' 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:
--
-- 'behavior', 'cacheBehaviorPerPath_behavior' - The cache behavior for the specified path.
--
-- You can specify one of the following per-path cache behaviors:
--
-- -   __@cache@__ - This behavior caches the specified path.
--
-- -   __@dont-cache@__ - This behavior doesn\'t cache the specified path.
--
-- 'path', 'cacheBehaviorPerPath_path' - The path to a directory or file to cached, or not cache. Use an asterisk
-- symbol to specify wildcard directories (@path\/to\/assets\/*@), and file
-- types (@*.html, *jpg, *js@). Directories and file paths are
-- case-sensitive.
--
-- Examples:
--
-- -   Specify the following to cache all files in the document root of an
--     Apache web server running on a Lightsail instance.
--
--     @var\/www\/html\/@
--
-- -   Specify the following file to cache only the index page in the
--     document root of an Apache web server.
--
--     @var\/www\/html\/index.html@
--
-- -   Specify the following to cache only the .html files in the document
--     root of an Apache web server.
--
--     @var\/www\/html\/*.html@
--
-- -   Specify the following to cache only the .jpg, .png, and .gif files
--     in the images sub-directory of the document root of an Apache web
--     server.
--
--     @var\/www\/html\/images\/*.jpg@
--
--     @var\/www\/html\/images\/*.png@
--
--     @var\/www\/html\/images\/*.gif@
--
--     Specify the following to cache all files in the images sub-directory
--     of the document root of an Apache web server.
--
--     @var\/www\/html\/images\/@
newCacheBehaviorPerPath ::
  CacheBehaviorPerPath
newCacheBehaviorPerPath :: CacheBehaviorPerPath
newCacheBehaviorPerPath =
  CacheBehaviorPerPath'
    { $sel:behavior:CacheBehaviorPerPath' :: Maybe BehaviorEnum
behavior = forall a. Maybe a
Prelude.Nothing,
      $sel:path:CacheBehaviorPerPath' :: Maybe Text
path = forall a. Maybe a
Prelude.Nothing
    }

-- | The cache behavior for the specified path.
--
-- You can specify one of the following per-path cache behaviors:
--
-- -   __@cache@__ - This behavior caches the specified path.
--
-- -   __@dont-cache@__ - This behavior doesn\'t cache the specified path.
cacheBehaviorPerPath_behavior :: Lens.Lens' CacheBehaviorPerPath (Prelude.Maybe BehaviorEnum)
cacheBehaviorPerPath_behavior :: Lens' CacheBehaviorPerPath (Maybe BehaviorEnum)
cacheBehaviorPerPath_behavior = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CacheBehaviorPerPath' {Maybe BehaviorEnum
behavior :: Maybe BehaviorEnum
$sel:behavior:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe BehaviorEnum
behavior} -> Maybe BehaviorEnum
behavior) (\s :: CacheBehaviorPerPath
s@CacheBehaviorPerPath' {} Maybe BehaviorEnum
a -> CacheBehaviorPerPath
s {$sel:behavior:CacheBehaviorPerPath' :: Maybe BehaviorEnum
behavior = Maybe BehaviorEnum
a} :: CacheBehaviorPerPath)

-- | The path to a directory or file to cached, or not cache. Use an asterisk
-- symbol to specify wildcard directories (@path\/to\/assets\/*@), and file
-- types (@*.html, *jpg, *js@). Directories and file paths are
-- case-sensitive.
--
-- Examples:
--
-- -   Specify the following to cache all files in the document root of an
--     Apache web server running on a Lightsail instance.
--
--     @var\/www\/html\/@
--
-- -   Specify the following file to cache only the index page in the
--     document root of an Apache web server.
--
--     @var\/www\/html\/index.html@
--
-- -   Specify the following to cache only the .html files in the document
--     root of an Apache web server.
--
--     @var\/www\/html\/*.html@
--
-- -   Specify the following to cache only the .jpg, .png, and .gif files
--     in the images sub-directory of the document root of an Apache web
--     server.
--
--     @var\/www\/html\/images\/*.jpg@
--
--     @var\/www\/html\/images\/*.png@
--
--     @var\/www\/html\/images\/*.gif@
--
--     Specify the following to cache all files in the images sub-directory
--     of the document root of an Apache web server.
--
--     @var\/www\/html\/images\/@
cacheBehaviorPerPath_path :: Lens.Lens' CacheBehaviorPerPath (Prelude.Maybe Prelude.Text)
cacheBehaviorPerPath_path :: Lens' CacheBehaviorPerPath (Maybe Text)
cacheBehaviorPerPath_path = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CacheBehaviorPerPath' {Maybe Text
path :: Maybe Text
$sel:path:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe Text
path} -> Maybe Text
path) (\s :: CacheBehaviorPerPath
s@CacheBehaviorPerPath' {} Maybe Text
a -> CacheBehaviorPerPath
s {$sel:path:CacheBehaviorPerPath' :: Maybe Text
path = Maybe Text
a} :: CacheBehaviorPerPath)

instance Data.FromJSON CacheBehaviorPerPath where
  parseJSON :: Value -> Parser CacheBehaviorPerPath
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CacheBehaviorPerPath"
      ( \Object
x ->
          Maybe BehaviorEnum -> Maybe Text -> CacheBehaviorPerPath
CacheBehaviorPerPath'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"behavior")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"path")
      )

instance Prelude.Hashable CacheBehaviorPerPath where
  hashWithSalt :: Int -> CacheBehaviorPerPath -> Int
hashWithSalt Int
_salt CacheBehaviorPerPath' {Maybe Text
Maybe BehaviorEnum
path :: Maybe Text
behavior :: Maybe BehaviorEnum
$sel:path:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe Text
$sel:behavior:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe BehaviorEnum
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe BehaviorEnum
behavior
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
path

instance Prelude.NFData CacheBehaviorPerPath where
  rnf :: CacheBehaviorPerPath -> ()
rnf CacheBehaviorPerPath' {Maybe Text
Maybe BehaviorEnum
path :: Maybe Text
behavior :: Maybe BehaviorEnum
$sel:path:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe Text
$sel:behavior:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe BehaviorEnum
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe BehaviorEnum
behavior seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
path

instance Data.ToJSON CacheBehaviorPerPath where
  toJSON :: CacheBehaviorPerPath -> Value
toJSON CacheBehaviorPerPath' {Maybe Text
Maybe BehaviorEnum
path :: Maybe Text
behavior :: Maybe BehaviorEnum
$sel:path:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe Text
$sel:behavior:CacheBehaviorPerPath' :: CacheBehaviorPerPath -> Maybe BehaviorEnum
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"behavior" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe BehaviorEnum
behavior,
            (Key
"path" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
path
          ]
      )