AdditionalInstanceConfiguration.hs

{-# 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.ImageBuilder.Types.AdditionalInstanceConfiguration
-- 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.ImageBuilder.Types.AdditionalInstanceConfiguration where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.ImageBuilder.Types.SystemsManagerAgent
import qualified Amazonka.Prelude as Prelude

-- | In addition to your infrastruction configuration, these settings provide
-- an extra layer of control over your build instances. For instances where
-- Image Builder installs the Systems Manager agent, you can choose whether
-- to keep it for the AMI that you create. You can also specify commands to
-- run on launch for all of your build instances.
--
-- /See:/ 'newAdditionalInstanceConfiguration' smart constructor.
data AdditionalInstanceConfiguration = AdditionalInstanceConfiguration'
  { -- | Contains settings for the Systems Manager agent on your build instance.
    systemsManagerAgent :: Prelude.Maybe SystemsManagerAgent,
    -- | Use this property to provide commands or a command script to run when
    -- you launch your build instance.
    --
    -- The userDataOverride property replaces any commands that Image Builder
    -- might have added to ensure that Systems Manager is installed on your
    -- Linux build instance. If you override the user data, make sure that you
    -- add commands to install Systems Manager, if it is not pre-installed on
    -- your base image.
    --
    -- The user data is always base 64 encoded. For example, the following
    -- commands are encoded as
    -- @IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$@:
    --
    -- /#!\/bin\/bash/
    --
    -- mkdir -p \/var\/bb\/
    --
    -- touch \/var
    userDataOverride :: Prelude.Maybe Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'AdditionalInstanceConfiguration' 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:
--
-- 'systemsManagerAgent', 'additionalInstanceConfiguration_systemsManagerAgent' - Contains settings for the Systems Manager agent on your build instance.
--
-- 'userDataOverride', 'additionalInstanceConfiguration_userDataOverride' - Use this property to provide commands or a command script to run when
-- you launch your build instance.
--
-- The userDataOverride property replaces any commands that Image Builder
-- might have added to ensure that Systems Manager is installed on your
-- Linux build instance. If you override the user data, make sure that you
-- add commands to install Systems Manager, if it is not pre-installed on
-- your base image.
--
-- The user data is always base 64 encoded. For example, the following
-- commands are encoded as
-- @IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$@:
--
-- /#!\/bin\/bash/
--
-- mkdir -p \/var\/bb\/
--
-- touch \/var
newAdditionalInstanceConfiguration ::
  AdditionalInstanceConfiguration
newAdditionalInstanceConfiguration =
  AdditionalInstanceConfiguration'
    { systemsManagerAgent =
        Prelude.Nothing,
      userDataOverride = Prelude.Nothing
    }

-- | Contains settings for the Systems Manager agent on your build instance.
additionalInstanceConfiguration_systemsManagerAgent :: Lens.Lens' AdditionalInstanceConfiguration (Prelude.Maybe SystemsManagerAgent)
additionalInstanceConfiguration_systemsManagerAgent = Lens.lens (\AdditionalInstanceConfiguration' {systemsManagerAgent} -> systemsManagerAgent) (\s@AdditionalInstanceConfiguration' {} a -> s {systemsManagerAgent = a} :: AdditionalInstanceConfiguration)

-- | Use this property to provide commands or a command script to run when
-- you launch your build instance.
--
-- The userDataOverride property replaces any commands that Image Builder
-- might have added to ensure that Systems Manager is installed on your
-- Linux build instance. If you override the user data, make sure that you
-- add commands to install Systems Manager, if it is not pre-installed on
-- your base image.
--
-- The user data is always base 64 encoded. For example, the following
-- commands are encoded as
-- @IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$@:
--
-- /#!\/bin\/bash/
--
-- mkdir -p \/var\/bb\/
--
-- touch \/var
additionalInstanceConfiguration_userDataOverride :: Lens.Lens' AdditionalInstanceConfiguration (Prelude.Maybe Prelude.Text)
additionalInstanceConfiguration_userDataOverride = Lens.lens (\AdditionalInstanceConfiguration' {userDataOverride} -> userDataOverride) (\s@AdditionalInstanceConfiguration' {} a -> s {userDataOverride = a} :: AdditionalInstanceConfiguration)

instance
  Data.FromJSON
    AdditionalInstanceConfiguration
  where
  parseJSON =
    Data.withObject
      "AdditionalInstanceConfiguration"
      ( \x ->
          AdditionalInstanceConfiguration'
            Prelude.<$> (x Data..:? "systemsManagerAgent")
            Prelude.<*> (x Data..:? "userDataOverride")
      )

instance
  Prelude.Hashable
    AdditionalInstanceConfiguration
  where
  hashWithSalt
    _salt
    AdditionalInstanceConfiguration' {..} =
      _salt
        `Prelude.hashWithSalt` systemsManagerAgent
        `Prelude.hashWithSalt` userDataOverride

instance
  Prelude.NFData
    AdditionalInstanceConfiguration
  where
  rnf AdditionalInstanceConfiguration' {..} =
    Prelude.rnf systemsManagerAgent
      `Prelude.seq` Prelude.rnf userDataOverride

instance Data.ToJSON AdditionalInstanceConfiguration where
  toJSON AdditionalInstanceConfiguration' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("systemsManagerAgent" Data..=)
              Prelude.<$> systemsManagerAgent,
            ("userDataOverride" Data..=)
              Prelude.<$> userDataOverride
          ]
      )