{-# 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.EC2.Types.BlockDeviceMapping
-- 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.EC2.Types.BlockDeviceMapping where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.EC2.Internal
import Amazonka.EC2.Types.EbsBlockDevice
import qualified Amazonka.Prelude as Prelude

-- | Describes a block device mapping, which defines the EBS volumes and
-- instance store volumes to attach to an instance at launch.
--
-- /See:/ 'newBlockDeviceMapping' smart constructor.
data BlockDeviceMapping = BlockDeviceMapping'
  { -- | Parameters used to automatically set up EBS volumes when the instance is
    -- launched.
    BlockDeviceMapping -> Maybe EbsBlockDevice
ebs :: Prelude.Maybe EbsBlockDevice,
    -- | To omit the device from the block device mapping, specify an empty
    -- string. When this property is specified, the device is removed from the
    -- block device mapping regardless of the assigned value.
    BlockDeviceMapping -> Maybe Text
noDevice :: Prelude.Maybe Prelude.Text,
    -- | The virtual device name (@ephemeral@N). Instance store volumes are
    -- numbered starting from 0. An instance type with 2 available instance
    -- store volumes can specify mappings for @ephemeral0@ and @ephemeral1@.
    -- The number of available instance store volumes depends on the instance
    -- type. After you connect to the instance, you must mount the volume.
    --
    -- NVMe instance store volumes are automatically enumerated and assigned a
    -- device name. Including them in your block device mapping has no effect.
    --
    -- Constraints: For M3 instances, you must specify instance store volumes
    -- in the block device mapping for the instance. When you launch an M3
    -- instance, we ignore any instance store volumes specified in the block
    -- device mapping for the AMI.
    BlockDeviceMapping -> Maybe Text
virtualName :: Prelude.Maybe Prelude.Text,
    -- | The device name (for example, @\/dev\/sdh@ or @xvdh@).
    BlockDeviceMapping -> Text
deviceName :: Prelude.Text
  }
  deriving (BlockDeviceMapping -> BlockDeviceMapping -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BlockDeviceMapping -> BlockDeviceMapping -> Bool
$c/= :: BlockDeviceMapping -> BlockDeviceMapping -> Bool
== :: BlockDeviceMapping -> BlockDeviceMapping -> Bool
$c== :: BlockDeviceMapping -> BlockDeviceMapping -> Bool
Prelude.Eq, ReadPrec [BlockDeviceMapping]
ReadPrec BlockDeviceMapping
Int -> ReadS BlockDeviceMapping
ReadS [BlockDeviceMapping]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BlockDeviceMapping]
$creadListPrec :: ReadPrec [BlockDeviceMapping]
readPrec :: ReadPrec BlockDeviceMapping
$creadPrec :: ReadPrec BlockDeviceMapping
readList :: ReadS [BlockDeviceMapping]
$creadList :: ReadS [BlockDeviceMapping]
readsPrec :: Int -> ReadS BlockDeviceMapping
$creadsPrec :: Int -> ReadS BlockDeviceMapping
Prelude.Read, Int -> BlockDeviceMapping -> ShowS
[BlockDeviceMapping] -> ShowS
BlockDeviceMapping -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BlockDeviceMapping] -> ShowS
$cshowList :: [BlockDeviceMapping] -> ShowS
show :: BlockDeviceMapping -> String
$cshow :: BlockDeviceMapping -> String
showsPrec :: Int -> BlockDeviceMapping -> ShowS
$cshowsPrec :: Int -> BlockDeviceMapping -> ShowS
Prelude.Show, forall x. Rep BlockDeviceMapping x -> BlockDeviceMapping
forall x. BlockDeviceMapping -> Rep BlockDeviceMapping x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BlockDeviceMapping x -> BlockDeviceMapping
$cfrom :: forall x. BlockDeviceMapping -> Rep BlockDeviceMapping x
Prelude.Generic)

-- |
-- Create a value of 'BlockDeviceMapping' 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:
--
-- 'ebs', 'blockDeviceMapping_ebs' - Parameters used to automatically set up EBS volumes when the instance is
-- launched.
--
-- 'noDevice', 'blockDeviceMapping_noDevice' - To omit the device from the block device mapping, specify an empty
-- string. When this property is specified, the device is removed from the
-- block device mapping regardless of the assigned value.
--
-- 'virtualName', 'blockDeviceMapping_virtualName' - The virtual device name (@ephemeral@N). Instance store volumes are
-- numbered starting from 0. An instance type with 2 available instance
-- store volumes can specify mappings for @ephemeral0@ and @ephemeral1@.
-- The number of available instance store volumes depends on the instance
-- type. After you connect to the instance, you must mount the volume.
--
-- NVMe instance store volumes are automatically enumerated and assigned a
-- device name. Including them in your block device mapping has no effect.
--
-- Constraints: For M3 instances, you must specify instance store volumes
-- in the block device mapping for the instance. When you launch an M3
-- instance, we ignore any instance store volumes specified in the block
-- device mapping for the AMI.
--
-- 'deviceName', 'blockDeviceMapping_deviceName' - The device name (for example, @\/dev\/sdh@ or @xvdh@).
newBlockDeviceMapping ::
  -- | 'deviceName'
  Prelude.Text ->
  BlockDeviceMapping
newBlockDeviceMapping :: Text -> BlockDeviceMapping
newBlockDeviceMapping Text
pDeviceName_ =
  BlockDeviceMapping'
    { $sel:ebs:BlockDeviceMapping' :: Maybe EbsBlockDevice
ebs = forall a. Maybe a
Prelude.Nothing,
      $sel:noDevice:BlockDeviceMapping' :: Maybe Text
noDevice = forall a. Maybe a
Prelude.Nothing,
      $sel:virtualName:BlockDeviceMapping' :: Maybe Text
virtualName = forall a. Maybe a
Prelude.Nothing,
      $sel:deviceName:BlockDeviceMapping' :: Text
deviceName = Text
pDeviceName_
    }

-- | Parameters used to automatically set up EBS volumes when the instance is
-- launched.
blockDeviceMapping_ebs :: Lens.Lens' BlockDeviceMapping (Prelude.Maybe EbsBlockDevice)
blockDeviceMapping_ebs :: Lens' BlockDeviceMapping (Maybe EbsBlockDevice)
blockDeviceMapping_ebs = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockDeviceMapping' {Maybe EbsBlockDevice
ebs :: Maybe EbsBlockDevice
$sel:ebs:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe EbsBlockDevice
ebs} -> Maybe EbsBlockDevice
ebs) (\s :: BlockDeviceMapping
s@BlockDeviceMapping' {} Maybe EbsBlockDevice
a -> BlockDeviceMapping
s {$sel:ebs:BlockDeviceMapping' :: Maybe EbsBlockDevice
ebs = Maybe EbsBlockDevice
a} :: BlockDeviceMapping)

-- | To omit the device from the block device mapping, specify an empty
-- string. When this property is specified, the device is removed from the
-- block device mapping regardless of the assigned value.
blockDeviceMapping_noDevice :: Lens.Lens' BlockDeviceMapping (Prelude.Maybe Prelude.Text)
blockDeviceMapping_noDevice :: Lens' BlockDeviceMapping (Maybe Text)
blockDeviceMapping_noDevice = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockDeviceMapping' {Maybe Text
noDevice :: Maybe Text
$sel:noDevice:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
noDevice} -> Maybe Text
noDevice) (\s :: BlockDeviceMapping
s@BlockDeviceMapping' {} Maybe Text
a -> BlockDeviceMapping
s {$sel:noDevice:BlockDeviceMapping' :: Maybe Text
noDevice = Maybe Text
a} :: BlockDeviceMapping)

-- | The virtual device name (@ephemeral@N). Instance store volumes are
-- numbered starting from 0. An instance type with 2 available instance
-- store volumes can specify mappings for @ephemeral0@ and @ephemeral1@.
-- The number of available instance store volumes depends on the instance
-- type. After you connect to the instance, you must mount the volume.
--
-- NVMe instance store volumes are automatically enumerated and assigned a
-- device name. Including them in your block device mapping has no effect.
--
-- Constraints: For M3 instances, you must specify instance store volumes
-- in the block device mapping for the instance. When you launch an M3
-- instance, we ignore any instance store volumes specified in the block
-- device mapping for the AMI.
blockDeviceMapping_virtualName :: Lens.Lens' BlockDeviceMapping (Prelude.Maybe Prelude.Text)
blockDeviceMapping_virtualName :: Lens' BlockDeviceMapping (Maybe Text)
blockDeviceMapping_virtualName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockDeviceMapping' {Maybe Text
virtualName :: Maybe Text
$sel:virtualName:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
virtualName} -> Maybe Text
virtualName) (\s :: BlockDeviceMapping
s@BlockDeviceMapping' {} Maybe Text
a -> BlockDeviceMapping
s {$sel:virtualName:BlockDeviceMapping' :: Maybe Text
virtualName = Maybe Text
a} :: BlockDeviceMapping)

-- | The device name (for example, @\/dev\/sdh@ or @xvdh@).
blockDeviceMapping_deviceName :: Lens.Lens' BlockDeviceMapping Prelude.Text
blockDeviceMapping_deviceName :: Lens' BlockDeviceMapping Text
blockDeviceMapping_deviceName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockDeviceMapping' {Text
deviceName :: Text
$sel:deviceName:BlockDeviceMapping' :: BlockDeviceMapping -> Text
deviceName} -> Text
deviceName) (\s :: BlockDeviceMapping
s@BlockDeviceMapping' {} Text
a -> BlockDeviceMapping
s {$sel:deviceName:BlockDeviceMapping' :: Text
deviceName = Text
a} :: BlockDeviceMapping)

instance Data.FromXML BlockDeviceMapping where
  parseXML :: [Node] -> Either String BlockDeviceMapping
parseXML [Node]
x =
    Maybe EbsBlockDevice
-> Maybe Text -> Maybe Text -> Text -> BlockDeviceMapping
BlockDeviceMapping'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"ebs")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"noDevice")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"virtualName")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"deviceName")

instance Prelude.Hashable BlockDeviceMapping where
  hashWithSalt :: Int -> BlockDeviceMapping -> Int
hashWithSalt Int
_salt BlockDeviceMapping' {Maybe Text
Maybe EbsBlockDevice
Text
deviceName :: Text
virtualName :: Maybe Text
noDevice :: Maybe Text
ebs :: Maybe EbsBlockDevice
$sel:deviceName:BlockDeviceMapping' :: BlockDeviceMapping -> Text
$sel:virtualName:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
$sel:noDevice:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
$sel:ebs:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe EbsBlockDevice
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EbsBlockDevice
ebs
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
noDevice
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
virtualName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
deviceName

instance Prelude.NFData BlockDeviceMapping where
  rnf :: BlockDeviceMapping -> ()
rnf BlockDeviceMapping' {Maybe Text
Maybe EbsBlockDevice
Text
deviceName :: Text
virtualName :: Maybe Text
noDevice :: Maybe Text
ebs :: Maybe EbsBlockDevice
$sel:deviceName:BlockDeviceMapping' :: BlockDeviceMapping -> Text
$sel:virtualName:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
$sel:noDevice:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
$sel:ebs:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe EbsBlockDevice
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe EbsBlockDevice
ebs
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
noDevice
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
virtualName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
deviceName

instance Data.ToQuery BlockDeviceMapping where
  toQuery :: BlockDeviceMapping -> QueryString
toQuery BlockDeviceMapping' {Maybe Text
Maybe EbsBlockDevice
Text
deviceName :: Text
virtualName :: Maybe Text
noDevice :: Maybe Text
ebs :: Maybe EbsBlockDevice
$sel:deviceName:BlockDeviceMapping' :: BlockDeviceMapping -> Text
$sel:virtualName:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
$sel:noDevice:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe Text
$sel:ebs:BlockDeviceMapping' :: BlockDeviceMapping -> Maybe EbsBlockDevice
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Ebs" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe EbsBlockDevice
ebs,
        ByteString
"NoDevice" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
noDevice,
        ByteString
"VirtualName" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
virtualName,
        ByteString
"DeviceName" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
deviceName
      ]