{-# 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.SecurityHub.Types.AwsNetworkFirewallRuleGroupDetails
-- 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.SecurityHub.Types.AwsNetworkFirewallRuleGroupDetails 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.SecurityHub.Types.RuleGroupDetails

-- | Details about an Network Firewall rule group. Rule groups are used to
-- inspect and control network traffic. Stateless rule groups apply to
-- individual packets. Stateful rule groups apply to packets in the context
-- of their traffic flow.
--
-- Rule groups are referenced in firewall policies.
--
-- /See:/ 'newAwsNetworkFirewallRuleGroupDetails' smart constructor.
data AwsNetworkFirewallRuleGroupDetails = AwsNetworkFirewallRuleGroupDetails'
  { -- | The maximum number of operating resources that this rule group can use.
    capacity :: Prelude.Maybe Prelude.Int,
    -- | A description of the rule group.
    description :: Prelude.Maybe Prelude.Text,
    -- | Details about the rule group.
    ruleGroup :: Prelude.Maybe RuleGroupDetails,
    -- | The ARN of the rule group.
    ruleGroupArn :: Prelude.Maybe Prelude.Text,
    -- | The identifier of the rule group.
    ruleGroupId :: Prelude.Maybe Prelude.Text,
    -- | The descriptive name of the rule group.
    ruleGroupName :: Prelude.Maybe Prelude.Text,
    -- | The type of rule group. A rule group can be stateful or stateless.
    type' :: Prelude.Maybe Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'AwsNetworkFirewallRuleGroupDetails' 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:
--
-- 'capacity', 'awsNetworkFirewallRuleGroupDetails_capacity' - The maximum number of operating resources that this rule group can use.
--
-- 'description', 'awsNetworkFirewallRuleGroupDetails_description' - A description of the rule group.
--
-- 'ruleGroup', 'awsNetworkFirewallRuleGroupDetails_ruleGroup' - Details about the rule group.
--
-- 'ruleGroupArn', 'awsNetworkFirewallRuleGroupDetails_ruleGroupArn' - The ARN of the rule group.
--
-- 'ruleGroupId', 'awsNetworkFirewallRuleGroupDetails_ruleGroupId' - The identifier of the rule group.
--
-- 'ruleGroupName', 'awsNetworkFirewallRuleGroupDetails_ruleGroupName' - The descriptive name of the rule group.
--
-- 'type'', 'awsNetworkFirewallRuleGroupDetails_type' - The type of rule group. A rule group can be stateful or stateless.
newAwsNetworkFirewallRuleGroupDetails ::
  AwsNetworkFirewallRuleGroupDetails
newAwsNetworkFirewallRuleGroupDetails =
  AwsNetworkFirewallRuleGroupDetails'
    { capacity =
        Prelude.Nothing,
      description = Prelude.Nothing,
      ruleGroup = Prelude.Nothing,
      ruleGroupArn = Prelude.Nothing,
      ruleGroupId = Prelude.Nothing,
      ruleGroupName = Prelude.Nothing,
      type' = Prelude.Nothing
    }

-- | The maximum number of operating resources that this rule group can use.
awsNetworkFirewallRuleGroupDetails_capacity :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe Prelude.Int)
awsNetworkFirewallRuleGroupDetails_capacity = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {capacity} -> capacity) (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {capacity = a} :: AwsNetworkFirewallRuleGroupDetails)

-- | A description of the rule group.
awsNetworkFirewallRuleGroupDetails_description :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe Prelude.Text)
awsNetworkFirewallRuleGroupDetails_description = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {description} -> description) (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {description = a} :: AwsNetworkFirewallRuleGroupDetails)

-- | Details about the rule group.
awsNetworkFirewallRuleGroupDetails_ruleGroup :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe RuleGroupDetails)
awsNetworkFirewallRuleGroupDetails_ruleGroup = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {ruleGroup} -> ruleGroup) (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {ruleGroup = a} :: AwsNetworkFirewallRuleGroupDetails)

-- | The ARN of the rule group.
awsNetworkFirewallRuleGroupDetails_ruleGroupArn :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe Prelude.Text)
awsNetworkFirewallRuleGroupDetails_ruleGroupArn = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {ruleGroupArn} -> ruleGroupArn) (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {ruleGroupArn = a} :: AwsNetworkFirewallRuleGroupDetails)

-- | The identifier of the rule group.
awsNetworkFirewallRuleGroupDetails_ruleGroupId :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe Prelude.Text)
awsNetworkFirewallRuleGroupDetails_ruleGroupId = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {ruleGroupId} -> ruleGroupId) (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {ruleGroupId = a} :: AwsNetworkFirewallRuleGroupDetails)

-- | The descriptive name of the rule group.
awsNetworkFirewallRuleGroupDetails_ruleGroupName :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe Prelude.Text)
awsNetworkFirewallRuleGroupDetails_ruleGroupName = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {ruleGroupName} -> ruleGroupName) (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {ruleGroupName = a} :: AwsNetworkFirewallRuleGroupDetails)

-- | The type of rule group. A rule group can be stateful or stateless.
awsNetworkFirewallRuleGroupDetails_type :: Lens.Lens' AwsNetworkFirewallRuleGroupDetails (Prelude.Maybe Prelude.Text)
awsNetworkFirewallRuleGroupDetails_type = Lens.lens (\AwsNetworkFirewallRuleGroupDetails' {type'} -> type') (\s@AwsNetworkFirewallRuleGroupDetails' {} a -> s {type' = a} :: AwsNetworkFirewallRuleGroupDetails)

instance
  Data.FromJSON
    AwsNetworkFirewallRuleGroupDetails
  where
  parseJSON =
    Data.withObject
      "AwsNetworkFirewallRuleGroupDetails"
      ( \x ->
          AwsNetworkFirewallRuleGroupDetails'
            Prelude.<$> (x Data..:? "Capacity")
            Prelude.<*> (x Data..:? "Description")
            Prelude.<*> (x Data..:? "RuleGroup")
            Prelude.<*> (x Data..:? "RuleGroupArn")
            Prelude.<*> (x Data..:? "RuleGroupId")
            Prelude.<*> (x Data..:? "RuleGroupName")
            Prelude.<*> (x Data..:? "Type")
      )

instance
  Prelude.Hashable
    AwsNetworkFirewallRuleGroupDetails
  where
  hashWithSalt
    _salt
    AwsNetworkFirewallRuleGroupDetails' {..} =
      _salt
        `Prelude.hashWithSalt` capacity
        `Prelude.hashWithSalt` description
        `Prelude.hashWithSalt` ruleGroup
        `Prelude.hashWithSalt` ruleGroupArn
        `Prelude.hashWithSalt` ruleGroupId
        `Prelude.hashWithSalt` ruleGroupName
        `Prelude.hashWithSalt` type'

instance
  Prelude.NFData
    AwsNetworkFirewallRuleGroupDetails
  where
  rnf AwsNetworkFirewallRuleGroupDetails' {..} =
    Prelude.rnf capacity
      `Prelude.seq` Prelude.rnf description
      `Prelude.seq` Prelude.rnf ruleGroup
      `Prelude.seq` Prelude.rnf ruleGroupArn
      `Prelude.seq` Prelude.rnf ruleGroupId
      `Prelude.seq` Prelude.rnf ruleGroupName
      `Prelude.seq` Prelude.rnf type'

instance
  Data.ToJSON
    AwsNetworkFirewallRuleGroupDetails
  where
  toJSON AwsNetworkFirewallRuleGroupDetails' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("Capacity" Data..=) Prelude.<$> capacity,
            ("Description" Data..=) Prelude.<$> description,
            ("RuleGroup" Data..=) Prelude.<$> ruleGroup,
            ("RuleGroupArn" Data..=) Prelude.<$> ruleGroupArn,
            ("RuleGroupId" Data..=) Prelude.<$> ruleGroupId,
            ("RuleGroupName" Data..=) Prelude.<$> ruleGroupName,
            ("Type" Data..=) Prelude.<$> type'
          ]
      )