{-# 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.SageMaker.Types.InstanceGroup
-- 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.SageMaker.Types.InstanceGroup 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.SageMaker.Types.TrainingInstanceType

-- | Defines an instance group for heterogeneous cluster training. When
-- requesting a training job using the
-- <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html CreateTrainingJob>
-- API, you can configure multiple instance groups .
--
-- /See:/ 'newInstanceGroup' smart constructor.
data InstanceGroup = InstanceGroup'
  { -- | Specifies the instance type of the instance group.
    InstanceGroup -> TrainingInstanceType
instanceType :: TrainingInstanceType,
    -- | Specifies the number of instances of the instance group.
    InstanceGroup -> Natural
instanceCount :: Prelude.Natural,
    -- | Specifies the name of the instance group.
    InstanceGroup -> Text
instanceGroupName :: Prelude.Text
  }
  deriving (InstanceGroup -> InstanceGroup -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InstanceGroup -> InstanceGroup -> Bool
$c/= :: InstanceGroup -> InstanceGroup -> Bool
== :: InstanceGroup -> InstanceGroup -> Bool
$c== :: InstanceGroup -> InstanceGroup -> Bool
Prelude.Eq, ReadPrec [InstanceGroup]
ReadPrec InstanceGroup
Int -> ReadS InstanceGroup
ReadS [InstanceGroup]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [InstanceGroup]
$creadListPrec :: ReadPrec [InstanceGroup]
readPrec :: ReadPrec InstanceGroup
$creadPrec :: ReadPrec InstanceGroup
readList :: ReadS [InstanceGroup]
$creadList :: ReadS [InstanceGroup]
readsPrec :: Int -> ReadS InstanceGroup
$creadsPrec :: Int -> ReadS InstanceGroup
Prelude.Read, Int -> InstanceGroup -> ShowS
[InstanceGroup] -> ShowS
InstanceGroup -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InstanceGroup] -> ShowS
$cshowList :: [InstanceGroup] -> ShowS
show :: InstanceGroup -> String
$cshow :: InstanceGroup -> String
showsPrec :: Int -> InstanceGroup -> ShowS
$cshowsPrec :: Int -> InstanceGroup -> ShowS
Prelude.Show, forall x. Rep InstanceGroup x -> InstanceGroup
forall x. InstanceGroup -> Rep InstanceGroup x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep InstanceGroup x -> InstanceGroup
$cfrom :: forall x. InstanceGroup -> Rep InstanceGroup x
Prelude.Generic)

-- |
-- Create a value of 'InstanceGroup' 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:
--
-- 'instanceType', 'instanceGroup_instanceType' - Specifies the instance type of the instance group.
--
-- 'instanceCount', 'instanceGroup_instanceCount' - Specifies the number of instances of the instance group.
--
-- 'instanceGroupName', 'instanceGroup_instanceGroupName' - Specifies the name of the instance group.
newInstanceGroup ::
  -- | 'instanceType'
  TrainingInstanceType ->
  -- | 'instanceCount'
  Prelude.Natural ->
  -- | 'instanceGroupName'
  Prelude.Text ->
  InstanceGroup
newInstanceGroup :: TrainingInstanceType -> Natural -> Text -> InstanceGroup
newInstanceGroup
  TrainingInstanceType
pInstanceType_
  Natural
pInstanceCount_
  Text
pInstanceGroupName_ =
    InstanceGroup'
      { $sel:instanceType:InstanceGroup' :: TrainingInstanceType
instanceType = TrainingInstanceType
pInstanceType_,
        $sel:instanceCount:InstanceGroup' :: Natural
instanceCount = Natural
pInstanceCount_,
        $sel:instanceGroupName:InstanceGroup' :: Text
instanceGroupName = Text
pInstanceGroupName_
      }

-- | Specifies the instance type of the instance group.
instanceGroup_instanceType :: Lens.Lens' InstanceGroup TrainingInstanceType
instanceGroup_instanceType :: Lens' InstanceGroup TrainingInstanceType
instanceGroup_instanceType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InstanceGroup' {TrainingInstanceType
instanceType :: TrainingInstanceType
$sel:instanceType:InstanceGroup' :: InstanceGroup -> TrainingInstanceType
instanceType} -> TrainingInstanceType
instanceType) (\s :: InstanceGroup
s@InstanceGroup' {} TrainingInstanceType
a -> InstanceGroup
s {$sel:instanceType:InstanceGroup' :: TrainingInstanceType
instanceType = TrainingInstanceType
a} :: InstanceGroup)

-- | Specifies the number of instances of the instance group.
instanceGroup_instanceCount :: Lens.Lens' InstanceGroup Prelude.Natural
instanceGroup_instanceCount :: Lens' InstanceGroup Natural
instanceGroup_instanceCount = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InstanceGroup' {Natural
instanceCount :: Natural
$sel:instanceCount:InstanceGroup' :: InstanceGroup -> Natural
instanceCount} -> Natural
instanceCount) (\s :: InstanceGroup
s@InstanceGroup' {} Natural
a -> InstanceGroup
s {$sel:instanceCount:InstanceGroup' :: Natural
instanceCount = Natural
a} :: InstanceGroup)

-- | Specifies the name of the instance group.
instanceGroup_instanceGroupName :: Lens.Lens' InstanceGroup Prelude.Text
instanceGroup_instanceGroupName :: Lens' InstanceGroup Text
instanceGroup_instanceGroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InstanceGroup' {Text
instanceGroupName :: Text
$sel:instanceGroupName:InstanceGroup' :: InstanceGroup -> Text
instanceGroupName} -> Text
instanceGroupName) (\s :: InstanceGroup
s@InstanceGroup' {} Text
a -> InstanceGroup
s {$sel:instanceGroupName:InstanceGroup' :: Text
instanceGroupName = Text
a} :: InstanceGroup)

instance Data.FromJSON InstanceGroup where
  parseJSON :: Value -> Parser InstanceGroup
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"InstanceGroup"
      ( \Object
x ->
          TrainingInstanceType -> Natural -> Text -> InstanceGroup
InstanceGroup'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"InstanceType")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"InstanceCount")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"InstanceGroupName")
      )

instance Prelude.Hashable InstanceGroup where
  hashWithSalt :: Int -> InstanceGroup -> Int
hashWithSalt Int
_salt InstanceGroup' {Natural
Text
TrainingInstanceType
instanceGroupName :: Text
instanceCount :: Natural
instanceType :: TrainingInstanceType
$sel:instanceGroupName:InstanceGroup' :: InstanceGroup -> Text
$sel:instanceCount:InstanceGroup' :: InstanceGroup -> Natural
$sel:instanceType:InstanceGroup' :: InstanceGroup -> TrainingInstanceType
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` TrainingInstanceType
instanceType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
instanceCount
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
instanceGroupName

instance Prelude.NFData InstanceGroup where
  rnf :: InstanceGroup -> ()
rnf InstanceGroup' {Natural
Text
TrainingInstanceType
instanceGroupName :: Text
instanceCount :: Natural
instanceType :: TrainingInstanceType
$sel:instanceGroupName:InstanceGroup' :: InstanceGroup -> Text
$sel:instanceCount:InstanceGroup' :: InstanceGroup -> Natural
$sel:instanceType:InstanceGroup' :: InstanceGroup -> TrainingInstanceType
..} =
    forall a. NFData a => a -> ()
Prelude.rnf TrainingInstanceType
instanceType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
instanceCount
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
instanceGroupName

instance Data.ToJSON InstanceGroup where
  toJSON :: InstanceGroup -> Value
toJSON InstanceGroup' {Natural
Text
TrainingInstanceType
instanceGroupName :: Text
instanceCount :: Natural
instanceType :: TrainingInstanceType
$sel:instanceGroupName:InstanceGroup' :: InstanceGroup -> Text
$sel:instanceCount:InstanceGroup' :: InstanceGroup -> Natural
$sel:instanceType:InstanceGroup' :: InstanceGroup -> TrainingInstanceType
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"InstanceType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= TrainingInstanceType
instanceType),
            forall a. a -> Maybe a
Prelude.Just (Key
"InstanceCount" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
instanceCount),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"InstanceGroupName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
instanceGroupName)
          ]
      )