{-# 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.Batch.Types.LaunchTemplateSpecification
-- 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.Batch.Types.LaunchTemplateSpecification 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

-- | An object that represents a launch template that\'s associated with a
-- compute resource. You must specify either the launch template ID or
-- launch template name in the request, but not both.
--
-- If security groups are specified using both the @securityGroupIds@
-- parameter of @CreateComputeEnvironment@ and the launch template, the
-- values in the @securityGroupIds@ parameter of @CreateComputeEnvironment@
-- will be used.
--
-- This object isn\'t applicable to jobs that are running on Fargate
-- resources.
--
-- /See:/ 'newLaunchTemplateSpecification' smart constructor.
data LaunchTemplateSpecification = LaunchTemplateSpecification'
  { -- | The ID of the launch template.
    LaunchTemplateSpecification -> Maybe Text
launchTemplateId :: Prelude.Maybe Prelude.Text,
    -- | The name of the launch template.
    LaunchTemplateSpecification -> Maybe Text
launchTemplateName :: Prelude.Maybe Prelude.Text,
    -- | The version number of the launch template, @$Latest@, or @$Default@.
    --
    -- If the value is @$Latest@, the latest version of the launch template is
    -- used. If the value is @$Default@, the default version of the launch
    -- template is used.
    --
    -- If the AMI ID that\'s used in a compute environment is from the launch
    -- template, the AMI isn\'t changed when the compute environment is
    -- updated. It\'s only changed if the @updateToLatestImageVersion@
    -- parameter for the compute environment is set to @true@. During an
    -- infrastructure update, if either @$Latest@ or @$Default@ is specified,
    -- Batch re-evaluates the launch template version, and it might use a
    -- different version of the launch template. This is the case even if the
    -- launch template isn\'t specified in the update. When updating a compute
    -- environment, changing the launch template requires an infrastructure
    -- update of the compute environment. For more information, see
    -- <https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Updating compute environments>
    -- in the /Batch User Guide/.
    --
    -- Default: @$Default@.
    LaunchTemplateSpecification -> Maybe Text
version :: Prelude.Maybe Prelude.Text
  }
  deriving (LaunchTemplateSpecification -> LaunchTemplateSpecification -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LaunchTemplateSpecification -> LaunchTemplateSpecification -> Bool
$c/= :: LaunchTemplateSpecification -> LaunchTemplateSpecification -> Bool
== :: LaunchTemplateSpecification -> LaunchTemplateSpecification -> Bool
$c== :: LaunchTemplateSpecification -> LaunchTemplateSpecification -> Bool
Prelude.Eq, ReadPrec [LaunchTemplateSpecification]
ReadPrec LaunchTemplateSpecification
Int -> ReadS LaunchTemplateSpecification
ReadS [LaunchTemplateSpecification]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [LaunchTemplateSpecification]
$creadListPrec :: ReadPrec [LaunchTemplateSpecification]
readPrec :: ReadPrec LaunchTemplateSpecification
$creadPrec :: ReadPrec LaunchTemplateSpecification
readList :: ReadS [LaunchTemplateSpecification]
$creadList :: ReadS [LaunchTemplateSpecification]
readsPrec :: Int -> ReadS LaunchTemplateSpecification
$creadsPrec :: Int -> ReadS LaunchTemplateSpecification
Prelude.Read, Int -> LaunchTemplateSpecification -> ShowS
[LaunchTemplateSpecification] -> ShowS
LaunchTemplateSpecification -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LaunchTemplateSpecification] -> ShowS
$cshowList :: [LaunchTemplateSpecification] -> ShowS
show :: LaunchTemplateSpecification -> String
$cshow :: LaunchTemplateSpecification -> String
showsPrec :: Int -> LaunchTemplateSpecification -> ShowS
$cshowsPrec :: Int -> LaunchTemplateSpecification -> ShowS
Prelude.Show, forall x.
Rep LaunchTemplateSpecification x -> LaunchTemplateSpecification
forall x.
LaunchTemplateSpecification -> Rep LaunchTemplateSpecification x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep LaunchTemplateSpecification x -> LaunchTemplateSpecification
$cfrom :: forall x.
LaunchTemplateSpecification -> Rep LaunchTemplateSpecification x
Prelude.Generic)

-- |
-- Create a value of 'LaunchTemplateSpecification' 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:
--
-- 'launchTemplateId', 'launchTemplateSpecification_launchTemplateId' - The ID of the launch template.
--
-- 'launchTemplateName', 'launchTemplateSpecification_launchTemplateName' - The name of the launch template.
--
-- 'version', 'launchTemplateSpecification_version' - The version number of the launch template, @$Latest@, or @$Default@.
--
-- If the value is @$Latest@, the latest version of the launch template is
-- used. If the value is @$Default@, the default version of the launch
-- template is used.
--
-- If the AMI ID that\'s used in a compute environment is from the launch
-- template, the AMI isn\'t changed when the compute environment is
-- updated. It\'s only changed if the @updateToLatestImageVersion@
-- parameter for the compute environment is set to @true@. During an
-- infrastructure update, if either @$Latest@ or @$Default@ is specified,
-- Batch re-evaluates the launch template version, and it might use a
-- different version of the launch template. This is the case even if the
-- launch template isn\'t specified in the update. When updating a compute
-- environment, changing the launch template requires an infrastructure
-- update of the compute environment. For more information, see
-- <https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Updating compute environments>
-- in the /Batch User Guide/.
--
-- Default: @$Default@.
newLaunchTemplateSpecification ::
  LaunchTemplateSpecification
newLaunchTemplateSpecification :: LaunchTemplateSpecification
newLaunchTemplateSpecification =
  LaunchTemplateSpecification'
    { $sel:launchTemplateId:LaunchTemplateSpecification' :: Maybe Text
launchTemplateId =
        forall a. Maybe a
Prelude.Nothing,
      $sel:launchTemplateName:LaunchTemplateSpecification' :: Maybe Text
launchTemplateName = forall a. Maybe a
Prelude.Nothing,
      $sel:version:LaunchTemplateSpecification' :: Maybe Text
version = forall a. Maybe a
Prelude.Nothing
    }

-- | The ID of the launch template.
launchTemplateSpecification_launchTemplateId :: Lens.Lens' LaunchTemplateSpecification (Prelude.Maybe Prelude.Text)
launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text)
launchTemplateSpecification_launchTemplateId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LaunchTemplateSpecification' {Maybe Text
launchTemplateId :: Maybe Text
$sel:launchTemplateId:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
launchTemplateId} -> Maybe Text
launchTemplateId) (\s :: LaunchTemplateSpecification
s@LaunchTemplateSpecification' {} Maybe Text
a -> LaunchTemplateSpecification
s {$sel:launchTemplateId:LaunchTemplateSpecification' :: Maybe Text
launchTemplateId = Maybe Text
a} :: LaunchTemplateSpecification)

-- | The name of the launch template.
launchTemplateSpecification_launchTemplateName :: Lens.Lens' LaunchTemplateSpecification (Prelude.Maybe Prelude.Text)
launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text)
launchTemplateSpecification_launchTemplateName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LaunchTemplateSpecification' {Maybe Text
launchTemplateName :: Maybe Text
$sel:launchTemplateName:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
launchTemplateName} -> Maybe Text
launchTemplateName) (\s :: LaunchTemplateSpecification
s@LaunchTemplateSpecification' {} Maybe Text
a -> LaunchTemplateSpecification
s {$sel:launchTemplateName:LaunchTemplateSpecification' :: Maybe Text
launchTemplateName = Maybe Text
a} :: LaunchTemplateSpecification)

-- | The version number of the launch template, @$Latest@, or @$Default@.
--
-- If the value is @$Latest@, the latest version of the launch template is
-- used. If the value is @$Default@, the default version of the launch
-- template is used.
--
-- If the AMI ID that\'s used in a compute environment is from the launch
-- template, the AMI isn\'t changed when the compute environment is
-- updated. It\'s only changed if the @updateToLatestImageVersion@
-- parameter for the compute environment is set to @true@. During an
-- infrastructure update, if either @$Latest@ or @$Default@ is specified,
-- Batch re-evaluates the launch template version, and it might use a
-- different version of the launch template. This is the case even if the
-- launch template isn\'t specified in the update. When updating a compute
-- environment, changing the launch template requires an infrastructure
-- update of the compute environment. For more information, see
-- <https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Updating compute environments>
-- in the /Batch User Guide/.
--
-- Default: @$Default@.
launchTemplateSpecification_version :: Lens.Lens' LaunchTemplateSpecification (Prelude.Maybe Prelude.Text)
launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text)
launchTemplateSpecification_version = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LaunchTemplateSpecification' {Maybe Text
version :: Maybe Text
$sel:version:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
version} -> Maybe Text
version) (\s :: LaunchTemplateSpecification
s@LaunchTemplateSpecification' {} Maybe Text
a -> LaunchTemplateSpecification
s {$sel:version:LaunchTemplateSpecification' :: Maybe Text
version = Maybe Text
a} :: LaunchTemplateSpecification)

instance Data.FromJSON LaunchTemplateSpecification where
  parseJSON :: Value -> Parser LaunchTemplateSpecification
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"LaunchTemplateSpecification"
      ( \Object
x ->
          Maybe Text
-> Maybe Text -> Maybe Text -> LaunchTemplateSpecification
LaunchTemplateSpecification'
            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
"launchTemplateId")
            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
"launchTemplateName")
            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
"version")
      )

instance Prelude.Hashable LaunchTemplateSpecification where
  hashWithSalt :: Int -> LaunchTemplateSpecification -> Int
hashWithSalt Int
_salt LaunchTemplateSpecification' {Maybe Text
version :: Maybe Text
launchTemplateName :: Maybe Text
launchTemplateId :: Maybe Text
$sel:version:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
$sel:launchTemplateName:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
$sel:launchTemplateId:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
launchTemplateId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
launchTemplateName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
version

instance Prelude.NFData LaunchTemplateSpecification where
  rnf :: LaunchTemplateSpecification -> ()
rnf LaunchTemplateSpecification' {Maybe Text
version :: Maybe Text
launchTemplateName :: Maybe Text
launchTemplateId :: Maybe Text
$sel:version:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
$sel:launchTemplateName:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
$sel:launchTemplateId:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
launchTemplateId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
launchTemplateName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
version

instance Data.ToJSON LaunchTemplateSpecification where
  toJSON :: LaunchTemplateSpecification -> Value
toJSON LaunchTemplateSpecification' {Maybe Text
version :: Maybe Text
launchTemplateName :: Maybe Text
launchTemplateId :: Maybe Text
$sel:version:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
$sel:launchTemplateName:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
$sel:launchTemplateId:LaunchTemplateSpecification' :: LaunchTemplateSpecification -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"launchTemplateId" 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
launchTemplateId,
            (Key
"launchTemplateName" 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
launchTemplateName,
            (Key
"version" 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
version
          ]
      )