{-# 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.ECS.Types.HealthCheck
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.ECS.Types.HealthCheck where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | An object representing a container health check. Health check parameters
-- that are specified in a container definition override any Docker health
-- checks that exist in the container image (such as those specified in a
-- parent image or from the image\'s Dockerfile).
--
-- You can view the health status of both individual containers and a task
-- with the DescribeTasks API operation or when viewing the task details in
-- the console.
--
-- The following describes the possible @healthStatus@ values for a
-- container:
--
-- -   @HEALTHY@-The container health check has passed successfully.
--
-- -   @UNHEALTHY@-The container health check has failed.
--
-- -   @UNKNOWN@-The container health check is being evaluated or there is
--     no container health check defined.
--
-- The following describes the possible @healthStatus@ values for a task.
-- The container health check status of nonessential containers do not have
-- an effect on the health status of a task.
--
-- -   @HEALTHY@-All essential containers within the task have passed their
--     health checks.
--
-- -   @UNHEALTHY@-One or more essential containers have failed their
--     health check.
--
-- -   @UNKNOWN@-The essential containers within the task are still having
--     their health checks evaluated or there are no container health
--     checks defined.
--
-- If a task is run manually, and not as part of a service, the task will
-- continue its lifecycle regardless of its health status. For tasks that
-- are part of a service, if the task reports as unhealthy then the task
-- will be stopped and the service scheduler will replace it.
--
-- The following are notes about container health check support:
--
-- -   Container health checks require version 1.17.0 or greater of the
--     Amazon ECS container agent. For more information, see
--     <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html Updating the Amazon ECS Container Agent>.
--
-- -   Container health checks are supported for Fargate tasks if you are
--     using platform version 1.1.0 or greater. For more information, see
--     <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html Fargate Platform Versions>.
--
-- -   Container health checks are not supported for tasks that are part of
--     a service that is configured to use a Classic Load Balancer.
--
-- /See:/ 'newHealthCheck' smart constructor.
data HealthCheck = HealthCheck'
  { -- | The optional grace period within which to provide containers time to
    -- bootstrap before failed health checks count towards the maximum number
    -- of retries. You may specify between 0 and 300 seconds. The @startPeriod@
    -- is disabled by default.
    --
    -- If a health check succeeds within the @startPeriod@, then the container
    -- is considered healthy and any subsequent failures count toward the
    -- maximum number of retries.
    HealthCheck -> Maybe Int
startPeriod :: Prelude.Maybe Prelude.Int,
    -- | The number of times to retry a failed health check before the container
    -- is considered unhealthy. You may specify between 1 and 10 retries. The
    -- default value is 3.
    HealthCheck -> Maybe Int
retries :: Prelude.Maybe Prelude.Int,
    -- | The time period in seconds between each health check execution. You may
    -- specify between 5 and 300 seconds. The default value is 30 seconds.
    HealthCheck -> Maybe Int
interval :: Prelude.Maybe Prelude.Int,
    -- | The time period in seconds to wait for a health check to succeed before
    -- it is considered a failure. You may specify between 2 and 60 seconds.
    -- The default value is 5.
    HealthCheck -> Maybe Int
timeout :: Prelude.Maybe Prelude.Int,
    -- | A string array representing the command that the container runs to
    -- determine if it is healthy. The string array must start with @CMD@ to
    -- execute the command arguments directly, or @CMD-SHELL@ to run the
    -- command with the container\'s default shell.
    --
    -- When you use the Amazon Web Services Management Console JSON panel, the
    -- Command Line Interface, or the APIs, you should enclose the list of
    -- commands in brackets, as shown below.
    --
    -- @[ \"CMD-SHELL\", \"curl -f http:\/\/localhost\/ || exit 1\" ]@
    --
    -- You do not need to include the brackets when you use the Amazon Web
    -- Services Management Consoleas shown below.
    --
    -- @ \"CMD-SHELL\", \"curl -f http:\/\/localhost\/ || exit 1\" @
    --
    -- An exit code of 0 indicates success, and non-zero exit code indicates
    -- failure. For more information, see @HealthCheck@ in the
    -- <https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate Create a container>
    -- section of the
    -- <https://docs.docker.com/engine/api/v1.35/ Docker Remote API>.
    HealthCheck -> [Text]
command :: [Prelude.Text]
  }
  deriving (HealthCheck -> HealthCheck -> Bool
(HealthCheck -> HealthCheck -> Bool)
-> (HealthCheck -> HealthCheck -> Bool) -> Eq HealthCheck
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HealthCheck -> HealthCheck -> Bool
$c/= :: HealthCheck -> HealthCheck -> Bool
== :: HealthCheck -> HealthCheck -> Bool
$c== :: HealthCheck -> HealthCheck -> Bool
Prelude.Eq, ReadPrec [HealthCheck]
ReadPrec HealthCheck
Int -> ReadS HealthCheck
ReadS [HealthCheck]
(Int -> ReadS HealthCheck)
-> ReadS [HealthCheck]
-> ReadPrec HealthCheck
-> ReadPrec [HealthCheck]
-> Read HealthCheck
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HealthCheck]
$creadListPrec :: ReadPrec [HealthCheck]
readPrec :: ReadPrec HealthCheck
$creadPrec :: ReadPrec HealthCheck
readList :: ReadS [HealthCheck]
$creadList :: ReadS [HealthCheck]
readsPrec :: Int -> ReadS HealthCheck
$creadsPrec :: Int -> ReadS HealthCheck
Prelude.Read, Int -> HealthCheck -> ShowS
[HealthCheck] -> ShowS
HealthCheck -> String
(Int -> HealthCheck -> ShowS)
-> (HealthCheck -> String)
-> ([HealthCheck] -> ShowS)
-> Show HealthCheck
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HealthCheck] -> ShowS
$cshowList :: [HealthCheck] -> ShowS
show :: HealthCheck -> String
$cshow :: HealthCheck -> String
showsPrec :: Int -> HealthCheck -> ShowS
$cshowsPrec :: Int -> HealthCheck -> ShowS
Prelude.Show, (forall x. HealthCheck -> Rep HealthCheck x)
-> (forall x. Rep HealthCheck x -> HealthCheck)
-> Generic HealthCheck
forall x. Rep HealthCheck x -> HealthCheck
forall x. HealthCheck -> Rep HealthCheck x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep HealthCheck x -> HealthCheck
$cfrom :: forall x. HealthCheck -> Rep HealthCheck x
Prelude.Generic)

-- |
-- Create a value of 'HealthCheck' 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:
--
-- 'startPeriod', 'healthCheck_startPeriod' - The optional grace period within which to provide containers time to
-- bootstrap before failed health checks count towards the maximum number
-- of retries. You may specify between 0 and 300 seconds. The @startPeriod@
-- is disabled by default.
--
-- If a health check succeeds within the @startPeriod@, then the container
-- is considered healthy and any subsequent failures count toward the
-- maximum number of retries.
--
-- 'retries', 'healthCheck_retries' - The number of times to retry a failed health check before the container
-- is considered unhealthy. You may specify between 1 and 10 retries. The
-- default value is 3.
--
-- 'interval', 'healthCheck_interval' - The time period in seconds between each health check execution. You may
-- specify between 5 and 300 seconds. The default value is 30 seconds.
--
-- 'timeout', 'healthCheck_timeout' - The time period in seconds to wait for a health check to succeed before
-- it is considered a failure. You may specify between 2 and 60 seconds.
-- The default value is 5.
--
-- 'command', 'healthCheck_command' - A string array representing the command that the container runs to
-- determine if it is healthy. The string array must start with @CMD@ to
-- execute the command arguments directly, or @CMD-SHELL@ to run the
-- command with the container\'s default shell.
--
-- When you use the Amazon Web Services Management Console JSON panel, the
-- Command Line Interface, or the APIs, you should enclose the list of
-- commands in brackets, as shown below.
--
-- @[ \"CMD-SHELL\", \"curl -f http:\/\/localhost\/ || exit 1\" ]@
--
-- You do not need to include the brackets when you use the Amazon Web
-- Services Management Consoleas shown below.
--
-- @ \"CMD-SHELL\", \"curl -f http:\/\/localhost\/ || exit 1\" @
--
-- An exit code of 0 indicates success, and non-zero exit code indicates
-- failure. For more information, see @HealthCheck@ in the
-- <https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate Create a container>
-- section of the
-- <https://docs.docker.com/engine/api/v1.35/ Docker Remote API>.
newHealthCheck ::
  HealthCheck
newHealthCheck :: HealthCheck
newHealthCheck =
  HealthCheck' :: Maybe Int
-> Maybe Int -> Maybe Int -> Maybe Int -> [Text] -> HealthCheck
HealthCheck'
    { $sel:startPeriod:HealthCheck' :: Maybe Int
startPeriod = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:retries:HealthCheck' :: Maybe Int
retries = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:interval:HealthCheck' :: Maybe Int
interval = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:timeout:HealthCheck' :: Maybe Int
timeout = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:command:HealthCheck' :: [Text]
command = [Text]
forall a. Monoid a => a
Prelude.mempty
    }

-- | The optional grace period within which to provide containers time to
-- bootstrap before failed health checks count towards the maximum number
-- of retries. You may specify between 0 and 300 seconds. The @startPeriod@
-- is disabled by default.
--
-- If a health check succeeds within the @startPeriod@, then the container
-- is considered healthy and any subsequent failures count toward the
-- maximum number of retries.
healthCheck_startPeriod :: Lens.Lens' HealthCheck (Prelude.Maybe Prelude.Int)
healthCheck_startPeriod :: (Maybe Int -> f (Maybe Int)) -> HealthCheck -> f HealthCheck
healthCheck_startPeriod = (HealthCheck -> Maybe Int)
-> (HealthCheck -> Maybe Int -> HealthCheck)
-> Lens HealthCheck HealthCheck (Maybe Int) (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HealthCheck' {Maybe Int
startPeriod :: Maybe Int
$sel:startPeriod:HealthCheck' :: HealthCheck -> Maybe Int
startPeriod} -> Maybe Int
startPeriod) (\s :: HealthCheck
s@HealthCheck' {} Maybe Int
a -> HealthCheck
s {$sel:startPeriod:HealthCheck' :: Maybe Int
startPeriod = Maybe Int
a} :: HealthCheck)

-- | The number of times to retry a failed health check before the container
-- is considered unhealthy. You may specify between 1 and 10 retries. The
-- default value is 3.
healthCheck_retries :: Lens.Lens' HealthCheck (Prelude.Maybe Prelude.Int)
healthCheck_retries :: (Maybe Int -> f (Maybe Int)) -> HealthCheck -> f HealthCheck
healthCheck_retries = (HealthCheck -> Maybe Int)
-> (HealthCheck -> Maybe Int -> HealthCheck)
-> Lens HealthCheck HealthCheck (Maybe Int) (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HealthCheck' {Maybe Int
retries :: Maybe Int
$sel:retries:HealthCheck' :: HealthCheck -> Maybe Int
retries} -> Maybe Int
retries) (\s :: HealthCheck
s@HealthCheck' {} Maybe Int
a -> HealthCheck
s {$sel:retries:HealthCheck' :: Maybe Int
retries = Maybe Int
a} :: HealthCheck)

-- | The time period in seconds between each health check execution. You may
-- specify between 5 and 300 seconds. The default value is 30 seconds.
healthCheck_interval :: Lens.Lens' HealthCheck (Prelude.Maybe Prelude.Int)
healthCheck_interval :: (Maybe Int -> f (Maybe Int)) -> HealthCheck -> f HealthCheck
healthCheck_interval = (HealthCheck -> Maybe Int)
-> (HealthCheck -> Maybe Int -> HealthCheck)
-> Lens HealthCheck HealthCheck (Maybe Int) (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HealthCheck' {Maybe Int
interval :: Maybe Int
$sel:interval:HealthCheck' :: HealthCheck -> Maybe Int
interval} -> Maybe Int
interval) (\s :: HealthCheck
s@HealthCheck' {} Maybe Int
a -> HealthCheck
s {$sel:interval:HealthCheck' :: Maybe Int
interval = Maybe Int
a} :: HealthCheck)

-- | The time period in seconds to wait for a health check to succeed before
-- it is considered a failure. You may specify between 2 and 60 seconds.
-- The default value is 5.
healthCheck_timeout :: Lens.Lens' HealthCheck (Prelude.Maybe Prelude.Int)
healthCheck_timeout :: (Maybe Int -> f (Maybe Int)) -> HealthCheck -> f HealthCheck
healthCheck_timeout = (HealthCheck -> Maybe Int)
-> (HealthCheck -> Maybe Int -> HealthCheck)
-> Lens HealthCheck HealthCheck (Maybe Int) (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HealthCheck' {Maybe Int
timeout :: Maybe Int
$sel:timeout:HealthCheck' :: HealthCheck -> Maybe Int
timeout} -> Maybe Int
timeout) (\s :: HealthCheck
s@HealthCheck' {} Maybe Int
a -> HealthCheck
s {$sel:timeout:HealthCheck' :: Maybe Int
timeout = Maybe Int
a} :: HealthCheck)

-- | A string array representing the command that the container runs to
-- determine if it is healthy. The string array must start with @CMD@ to
-- execute the command arguments directly, or @CMD-SHELL@ to run the
-- command with the container\'s default shell.
--
-- When you use the Amazon Web Services Management Console JSON panel, the
-- Command Line Interface, or the APIs, you should enclose the list of
-- commands in brackets, as shown below.
--
-- @[ \"CMD-SHELL\", \"curl -f http:\/\/localhost\/ || exit 1\" ]@
--
-- You do not need to include the brackets when you use the Amazon Web
-- Services Management Consoleas shown below.
--
-- @ \"CMD-SHELL\", \"curl -f http:\/\/localhost\/ || exit 1\" @
--
-- An exit code of 0 indicates success, and non-zero exit code indicates
-- failure. For more information, see @HealthCheck@ in the
-- <https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate Create a container>
-- section of the
-- <https://docs.docker.com/engine/api/v1.35/ Docker Remote API>.
healthCheck_command :: Lens.Lens' HealthCheck [Prelude.Text]
healthCheck_command :: ([Text] -> f [Text]) -> HealthCheck -> f HealthCheck
healthCheck_command = (HealthCheck -> [Text])
-> (HealthCheck -> [Text] -> HealthCheck)
-> Lens HealthCheck HealthCheck [Text] [Text]
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HealthCheck' {[Text]
command :: [Text]
$sel:command:HealthCheck' :: HealthCheck -> [Text]
command} -> [Text]
command) (\s :: HealthCheck
s@HealthCheck' {} [Text]
a -> HealthCheck
s {$sel:command:HealthCheck' :: [Text]
command = [Text]
a} :: HealthCheck) (([Text] -> f [Text]) -> HealthCheck -> f HealthCheck)
-> (([Text] -> f [Text]) -> [Text] -> f [Text])
-> ([Text] -> f [Text])
-> HealthCheck
-> f HealthCheck
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([Text] -> f [Text]) -> [Text] -> f [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.FromJSON HealthCheck where
  parseJSON :: Value -> Parser HealthCheck
parseJSON =
    String
-> (Object -> Parser HealthCheck) -> Value -> Parser HealthCheck
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"HealthCheck"
      ( \Object
x ->
          Maybe Int
-> Maybe Int -> Maybe Int -> Maybe Int -> [Text] -> HealthCheck
HealthCheck'
            (Maybe Int
 -> Maybe Int -> Maybe Int -> Maybe Int -> [Text] -> HealthCheck)
-> Parser (Maybe Int)
-> Parser
     (Maybe Int -> Maybe Int -> Maybe Int -> [Text] -> HealthCheck)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"startPeriod")
            Parser
  (Maybe Int -> Maybe Int -> Maybe Int -> [Text] -> HealthCheck)
-> Parser (Maybe Int)
-> Parser (Maybe Int -> Maybe Int -> [Text] -> HealthCheck)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"retries")
            Parser (Maybe Int -> Maybe Int -> [Text] -> HealthCheck)
-> Parser (Maybe Int)
-> Parser (Maybe Int -> [Text] -> HealthCheck)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"interval")
            Parser (Maybe Int -> [Text] -> HealthCheck)
-> Parser (Maybe Int) -> Parser ([Text] -> HealthCheck)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"timeout")
            Parser ([Text] -> HealthCheck)
-> Parser [Text] -> Parser HealthCheck
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe [Text])
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"command" Parser (Maybe [Text]) -> [Text] -> Parser [Text]
forall a. Parser (Maybe a) -> a -> Parser a
Core..!= [Text]
forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable HealthCheck

instance Prelude.NFData HealthCheck

instance Core.ToJSON HealthCheck where
  toJSON :: HealthCheck -> Value
toJSON HealthCheck' {[Text]
Maybe Int
command :: [Text]
timeout :: Maybe Int
interval :: Maybe Int
retries :: Maybe Int
startPeriod :: Maybe Int
$sel:command:HealthCheck' :: HealthCheck -> [Text]
$sel:timeout:HealthCheck' :: HealthCheck -> Maybe Int
$sel:interval:HealthCheck' :: HealthCheck -> Maybe Int
$sel:retries:HealthCheck' :: HealthCheck -> Maybe Int
$sel:startPeriod:HealthCheck' :: HealthCheck -> Maybe Int
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"startPeriod" Text -> Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Int -> Pair) -> Maybe Int -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Int
startPeriod,
            (Text
"retries" Text -> Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Int -> Pair) -> Maybe Int -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Int
retries,
            (Text
"interval" Text -> Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Int -> Pair) -> Maybe Int -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Int
interval,
            (Text
"timeout" Text -> Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Int -> Pair) -> Maybe Int -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Int
timeout,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"command" Text -> [Text] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= [Text]
command)
          ]
      )