ConnectivityInfo.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.GreengrassV2.Types.ConnectivityInfo
-- 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.GreengrassV2.Types.ConnectivityInfo 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

-- | Contains information about an endpoint and port where client devices can
-- connect to an MQTT broker on a Greengrass core device.
--
-- /See:/ 'newConnectivityInfo' smart constructor.
data ConnectivityInfo = ConnectivityInfo'
  { -- | The IP address or DNS address where client devices can connect to an
    -- MQTT broker on the Greengrass core device.
    hostAddress :: Prelude.Maybe Prelude.Text,
    -- | An ID for the connectivity information.
    id :: Prelude.Maybe Prelude.Text,
    -- | Additional metadata to provide to client devices that connect to this
    -- core device.
    metadata :: Prelude.Maybe Prelude.Text,
    -- | The port where the MQTT broker operates on the core device. This port is
    -- typically 8883, which is the default port for the MQTT broker component
    -- that runs on core devices.
    portNumber :: Prelude.Maybe Prelude.Natural
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ConnectivityInfo' 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:
--
-- 'hostAddress', 'connectivityInfo_hostAddress' - The IP address or DNS address where client devices can connect to an
-- MQTT broker on the Greengrass core device.
--
-- 'id', 'connectivityInfo_id' - An ID for the connectivity information.
--
-- 'metadata', 'connectivityInfo_metadata' - Additional metadata to provide to client devices that connect to this
-- core device.
--
-- 'portNumber', 'connectivityInfo_portNumber' - The port where the MQTT broker operates on the core device. This port is
-- typically 8883, which is the default port for the MQTT broker component
-- that runs on core devices.
newConnectivityInfo ::
  ConnectivityInfo
newConnectivityInfo =
  ConnectivityInfo'
    { hostAddress = Prelude.Nothing,
      id = Prelude.Nothing,
      metadata = Prelude.Nothing,
      portNumber = Prelude.Nothing
    }

-- | The IP address or DNS address where client devices can connect to an
-- MQTT broker on the Greengrass core device.
connectivityInfo_hostAddress :: Lens.Lens' ConnectivityInfo (Prelude.Maybe Prelude.Text)
connectivityInfo_hostAddress = Lens.lens (\ConnectivityInfo' {hostAddress} -> hostAddress) (\s@ConnectivityInfo' {} a -> s {hostAddress = a} :: ConnectivityInfo)

-- | An ID for the connectivity information.
connectivityInfo_id :: Lens.Lens' ConnectivityInfo (Prelude.Maybe Prelude.Text)
connectivityInfo_id = Lens.lens (\ConnectivityInfo' {id} -> id) (\s@ConnectivityInfo' {} a -> s {id = a} :: ConnectivityInfo)

-- | Additional metadata to provide to client devices that connect to this
-- core device.
connectivityInfo_metadata :: Lens.Lens' ConnectivityInfo (Prelude.Maybe Prelude.Text)
connectivityInfo_metadata = Lens.lens (\ConnectivityInfo' {metadata} -> metadata) (\s@ConnectivityInfo' {} a -> s {metadata = a} :: ConnectivityInfo)

-- | The port where the MQTT broker operates on the core device. This port is
-- typically 8883, which is the default port for the MQTT broker component
-- that runs on core devices.
connectivityInfo_portNumber :: Lens.Lens' ConnectivityInfo (Prelude.Maybe Prelude.Natural)
connectivityInfo_portNumber = Lens.lens (\ConnectivityInfo' {portNumber} -> portNumber) (\s@ConnectivityInfo' {} a -> s {portNumber = a} :: ConnectivityInfo)

instance Data.FromJSON ConnectivityInfo where
  parseJSON =
    Data.withObject
      "ConnectivityInfo"
      ( \x ->
          ConnectivityInfo'
            Prelude.<$> (x Data..:? "HostAddress")
            Prelude.<*> (x Data..:? "Id")
            Prelude.<*> (x Data..:? "Metadata")
            Prelude.<*> (x Data..:? "PortNumber")
      )

instance Prelude.Hashable ConnectivityInfo where
  hashWithSalt _salt ConnectivityInfo' {..} =
    _salt
      `Prelude.hashWithSalt` hostAddress
      `Prelude.hashWithSalt` id
      `Prelude.hashWithSalt` metadata
      `Prelude.hashWithSalt` portNumber

instance Prelude.NFData ConnectivityInfo where
  rnf ConnectivityInfo' {..} =
    Prelude.rnf hostAddress
      `Prelude.seq` Prelude.rnf id
      `Prelude.seq` Prelude.rnf metadata
      `Prelude.seq` Prelude.rnf portNumber

instance Data.ToJSON ConnectivityInfo where
  toJSON ConnectivityInfo' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("HostAddress" Data..=) Prelude.<$> hostAddress,
            ("Id" Data..=) Prelude.<$> id,
            ("Metadata" Data..=) Prelude.<$> metadata,
            ("PortNumber" Data..=) Prelude.<$> portNumber
          ]
      )