{-# 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.NetworkFirewall.Types.FirewallStatus
-- 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.NetworkFirewall.Types.FirewallStatus where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.NetworkFirewall.Types.CapacityUsageSummary
import Amazonka.NetworkFirewall.Types.ConfigurationSyncState
import Amazonka.NetworkFirewall.Types.FirewallStatusValue
import Amazonka.NetworkFirewall.Types.SyncState
import qualified Amazonka.Prelude as Prelude

-- | Detailed information about the current status of a Firewall. You can
-- retrieve this for a firewall by calling DescribeFirewall and providing
-- the firewall name and ARN.
--
-- /See:/ 'newFirewallStatus' smart constructor.
data FirewallStatus = FirewallStatus'
  { -- | Describes the capacity usage of the resources contained in a firewall\'s
    -- reference sets. Network Firewall calclulates the capacity usage by
    -- taking an aggregated count of all of the resources used by all of the
    -- reference sets in a firewall.
    FirewallStatus -> Maybe CapacityUsageSummary
capacityUsageSummary :: Prelude.Maybe CapacityUsageSummary,
    -- | The subnets that you\'ve configured for use by the Network Firewall
    -- firewall. This contains one array element per Availability Zone where
    -- you\'ve configured a subnet. These objects provide details of the
    -- information that is summarized in the @ConfigurationSyncStateSummary@
    -- and @Status@, broken down by zone and configuration object.
    FirewallStatus -> Maybe (HashMap Text SyncState)
syncStates :: Prelude.Maybe (Prelude.HashMap Prelude.Text SyncState),
    -- | The readiness of the configured firewall to handle network traffic
    -- across all of the Availability Zones where you\'ve configured it. This
    -- setting is @READY@ only when the @ConfigurationSyncStateSummary@ value
    -- is @IN_SYNC@ and the @Attachment@ @Status@ values for all of the
    -- configured subnets are @READY@.
    FirewallStatus -> FirewallStatusValue
status :: FirewallStatusValue,
    -- | The configuration sync state for the firewall. This summarizes the sync
    -- states reported in the @Config@ settings for all of the Availability
    -- Zones where you have configured the firewall.
    --
    -- When you create a firewall or update its configuration, for example by
    -- adding a rule group to its firewall policy, Network Firewall distributes
    -- the configuration changes to all zones where the firewall is in use.
    -- This summary indicates whether the configuration changes have been
    -- applied everywhere.
    --
    -- This status must be @IN_SYNC@ for the firewall to be ready for use, but
    -- it doesn\'t indicate that the firewall is ready. The @Status@ setting
    -- indicates firewall readiness.
    FirewallStatus -> ConfigurationSyncState
configurationSyncStateSummary :: ConfigurationSyncState
  }
  deriving (FirewallStatus -> FirewallStatus -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FirewallStatus -> FirewallStatus -> Bool
$c/= :: FirewallStatus -> FirewallStatus -> Bool
== :: FirewallStatus -> FirewallStatus -> Bool
$c== :: FirewallStatus -> FirewallStatus -> Bool
Prelude.Eq, ReadPrec [FirewallStatus]
ReadPrec FirewallStatus
Int -> ReadS FirewallStatus
ReadS [FirewallStatus]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FirewallStatus]
$creadListPrec :: ReadPrec [FirewallStatus]
readPrec :: ReadPrec FirewallStatus
$creadPrec :: ReadPrec FirewallStatus
readList :: ReadS [FirewallStatus]
$creadList :: ReadS [FirewallStatus]
readsPrec :: Int -> ReadS FirewallStatus
$creadsPrec :: Int -> ReadS FirewallStatus
Prelude.Read, Int -> FirewallStatus -> ShowS
[FirewallStatus] -> ShowS
FirewallStatus -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FirewallStatus] -> ShowS
$cshowList :: [FirewallStatus] -> ShowS
show :: FirewallStatus -> String
$cshow :: FirewallStatus -> String
showsPrec :: Int -> FirewallStatus -> ShowS
$cshowsPrec :: Int -> FirewallStatus -> ShowS
Prelude.Show, forall x. Rep FirewallStatus x -> FirewallStatus
forall x. FirewallStatus -> Rep FirewallStatus x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FirewallStatus x -> FirewallStatus
$cfrom :: forall x. FirewallStatus -> Rep FirewallStatus x
Prelude.Generic)

-- |
-- Create a value of 'FirewallStatus' 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:
--
-- 'capacityUsageSummary', 'firewallStatus_capacityUsageSummary' - Describes the capacity usage of the resources contained in a firewall\'s
-- reference sets. Network Firewall calclulates the capacity usage by
-- taking an aggregated count of all of the resources used by all of the
-- reference sets in a firewall.
--
-- 'syncStates', 'firewallStatus_syncStates' - The subnets that you\'ve configured for use by the Network Firewall
-- firewall. This contains one array element per Availability Zone where
-- you\'ve configured a subnet. These objects provide details of the
-- information that is summarized in the @ConfigurationSyncStateSummary@
-- and @Status@, broken down by zone and configuration object.
--
-- 'status', 'firewallStatus_status' - The readiness of the configured firewall to handle network traffic
-- across all of the Availability Zones where you\'ve configured it. This
-- setting is @READY@ only when the @ConfigurationSyncStateSummary@ value
-- is @IN_SYNC@ and the @Attachment@ @Status@ values for all of the
-- configured subnets are @READY@.
--
-- 'configurationSyncStateSummary', 'firewallStatus_configurationSyncStateSummary' - The configuration sync state for the firewall. This summarizes the sync
-- states reported in the @Config@ settings for all of the Availability
-- Zones where you have configured the firewall.
--
-- When you create a firewall or update its configuration, for example by
-- adding a rule group to its firewall policy, Network Firewall distributes
-- the configuration changes to all zones where the firewall is in use.
-- This summary indicates whether the configuration changes have been
-- applied everywhere.
--
-- This status must be @IN_SYNC@ for the firewall to be ready for use, but
-- it doesn\'t indicate that the firewall is ready. The @Status@ setting
-- indicates firewall readiness.
newFirewallStatus ::
  -- | 'status'
  FirewallStatusValue ->
  -- | 'configurationSyncStateSummary'
  ConfigurationSyncState ->
  FirewallStatus
newFirewallStatus :: FirewallStatusValue -> ConfigurationSyncState -> FirewallStatus
newFirewallStatus
  FirewallStatusValue
pStatus_
  ConfigurationSyncState
pConfigurationSyncStateSummary_ =
    FirewallStatus'
      { $sel:capacityUsageSummary:FirewallStatus' :: Maybe CapacityUsageSummary
capacityUsageSummary =
          forall a. Maybe a
Prelude.Nothing,
        $sel:syncStates:FirewallStatus' :: Maybe (HashMap Text SyncState)
syncStates = forall a. Maybe a
Prelude.Nothing,
        $sel:status:FirewallStatus' :: FirewallStatusValue
status = FirewallStatusValue
pStatus_,
        $sel:configurationSyncStateSummary:FirewallStatus' :: ConfigurationSyncState
configurationSyncStateSummary =
          ConfigurationSyncState
pConfigurationSyncStateSummary_
      }

-- | Describes the capacity usage of the resources contained in a firewall\'s
-- reference sets. Network Firewall calclulates the capacity usage by
-- taking an aggregated count of all of the resources used by all of the
-- reference sets in a firewall.
firewallStatus_capacityUsageSummary :: Lens.Lens' FirewallStatus (Prelude.Maybe CapacityUsageSummary)
firewallStatus_capacityUsageSummary :: Lens' FirewallStatus (Maybe CapacityUsageSummary)
firewallStatus_capacityUsageSummary = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirewallStatus' {Maybe CapacityUsageSummary
capacityUsageSummary :: Maybe CapacityUsageSummary
$sel:capacityUsageSummary:FirewallStatus' :: FirewallStatus -> Maybe CapacityUsageSummary
capacityUsageSummary} -> Maybe CapacityUsageSummary
capacityUsageSummary) (\s :: FirewallStatus
s@FirewallStatus' {} Maybe CapacityUsageSummary
a -> FirewallStatus
s {$sel:capacityUsageSummary:FirewallStatus' :: Maybe CapacityUsageSummary
capacityUsageSummary = Maybe CapacityUsageSummary
a} :: FirewallStatus)

-- | The subnets that you\'ve configured for use by the Network Firewall
-- firewall. This contains one array element per Availability Zone where
-- you\'ve configured a subnet. These objects provide details of the
-- information that is summarized in the @ConfigurationSyncStateSummary@
-- and @Status@, broken down by zone and configuration object.
firewallStatus_syncStates :: Lens.Lens' FirewallStatus (Prelude.Maybe (Prelude.HashMap Prelude.Text SyncState))
firewallStatus_syncStates :: Lens' FirewallStatus (Maybe (HashMap Text SyncState))
firewallStatus_syncStates = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirewallStatus' {Maybe (HashMap Text SyncState)
syncStates :: Maybe (HashMap Text SyncState)
$sel:syncStates:FirewallStatus' :: FirewallStatus -> Maybe (HashMap Text SyncState)
syncStates} -> Maybe (HashMap Text SyncState)
syncStates) (\s :: FirewallStatus
s@FirewallStatus' {} Maybe (HashMap Text SyncState)
a -> FirewallStatus
s {$sel:syncStates:FirewallStatus' :: Maybe (HashMap Text SyncState)
syncStates = Maybe (HashMap Text SyncState)
a} :: FirewallStatus) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The readiness of the configured firewall to handle network traffic
-- across all of the Availability Zones where you\'ve configured it. This
-- setting is @READY@ only when the @ConfigurationSyncStateSummary@ value
-- is @IN_SYNC@ and the @Attachment@ @Status@ values for all of the
-- configured subnets are @READY@.
firewallStatus_status :: Lens.Lens' FirewallStatus FirewallStatusValue
firewallStatus_status :: Lens' FirewallStatus FirewallStatusValue
firewallStatus_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirewallStatus' {FirewallStatusValue
status :: FirewallStatusValue
$sel:status:FirewallStatus' :: FirewallStatus -> FirewallStatusValue
status} -> FirewallStatusValue
status) (\s :: FirewallStatus
s@FirewallStatus' {} FirewallStatusValue
a -> FirewallStatus
s {$sel:status:FirewallStatus' :: FirewallStatusValue
status = FirewallStatusValue
a} :: FirewallStatus)

-- | The configuration sync state for the firewall. This summarizes the sync
-- states reported in the @Config@ settings for all of the Availability
-- Zones where you have configured the firewall.
--
-- When you create a firewall or update its configuration, for example by
-- adding a rule group to its firewall policy, Network Firewall distributes
-- the configuration changes to all zones where the firewall is in use.
-- This summary indicates whether the configuration changes have been
-- applied everywhere.
--
-- This status must be @IN_SYNC@ for the firewall to be ready for use, but
-- it doesn\'t indicate that the firewall is ready. The @Status@ setting
-- indicates firewall readiness.
firewallStatus_configurationSyncStateSummary :: Lens.Lens' FirewallStatus ConfigurationSyncState
firewallStatus_configurationSyncStateSummary :: Lens' FirewallStatus ConfigurationSyncState
firewallStatus_configurationSyncStateSummary = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirewallStatus' {ConfigurationSyncState
configurationSyncStateSummary :: ConfigurationSyncState
$sel:configurationSyncStateSummary:FirewallStatus' :: FirewallStatus -> ConfigurationSyncState
configurationSyncStateSummary} -> ConfigurationSyncState
configurationSyncStateSummary) (\s :: FirewallStatus
s@FirewallStatus' {} ConfigurationSyncState
a -> FirewallStatus
s {$sel:configurationSyncStateSummary:FirewallStatus' :: ConfigurationSyncState
configurationSyncStateSummary = ConfigurationSyncState
a} :: FirewallStatus)

instance Data.FromJSON FirewallStatus where
  parseJSON :: Value -> Parser FirewallStatus
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"FirewallStatus"
      ( \Object
x ->
          Maybe CapacityUsageSummary
-> Maybe (HashMap Text SyncState)
-> FirewallStatusValue
-> ConfigurationSyncState
-> FirewallStatus
FirewallStatus'
            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
"CapacityUsageSummary")
            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
"SyncStates" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"Status")
            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
"ConfigurationSyncStateSummary")
      )

instance Prelude.Hashable FirewallStatus where
  hashWithSalt :: Int -> FirewallStatus -> Int
hashWithSalt Int
_salt FirewallStatus' {Maybe (HashMap Text SyncState)
Maybe CapacityUsageSummary
ConfigurationSyncState
FirewallStatusValue
configurationSyncStateSummary :: ConfigurationSyncState
status :: FirewallStatusValue
syncStates :: Maybe (HashMap Text SyncState)
capacityUsageSummary :: Maybe CapacityUsageSummary
$sel:configurationSyncStateSummary:FirewallStatus' :: FirewallStatus -> ConfigurationSyncState
$sel:status:FirewallStatus' :: FirewallStatus -> FirewallStatusValue
$sel:syncStates:FirewallStatus' :: FirewallStatus -> Maybe (HashMap Text SyncState)
$sel:capacityUsageSummary:FirewallStatus' :: FirewallStatus -> Maybe CapacityUsageSummary
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CapacityUsageSummary
capacityUsageSummary
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text SyncState)
syncStates
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` FirewallStatusValue
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ConfigurationSyncState
configurationSyncStateSummary

instance Prelude.NFData FirewallStatus where
  rnf :: FirewallStatus -> ()
rnf FirewallStatus' {Maybe (HashMap Text SyncState)
Maybe CapacityUsageSummary
ConfigurationSyncState
FirewallStatusValue
configurationSyncStateSummary :: ConfigurationSyncState
status :: FirewallStatusValue
syncStates :: Maybe (HashMap Text SyncState)
capacityUsageSummary :: Maybe CapacityUsageSummary
$sel:configurationSyncStateSummary:FirewallStatus' :: FirewallStatus -> ConfigurationSyncState
$sel:status:FirewallStatus' :: FirewallStatus -> FirewallStatusValue
$sel:syncStates:FirewallStatus' :: FirewallStatus -> Maybe (HashMap Text SyncState)
$sel:capacityUsageSummary:FirewallStatus' :: FirewallStatus -> Maybe CapacityUsageSummary
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CapacityUsageSummary
capacityUsageSummary
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text SyncState)
syncStates
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf FirewallStatusValue
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ConfigurationSyncState
configurationSyncStateSummary