{-# 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.EKS.Types.KubernetesNetworkConfigRequest
-- 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.EKS.Types.KubernetesNetworkConfigRequest where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.EKS.Types.IpFamily
import qualified Amazonka.Prelude as Prelude

-- | The Kubernetes network configuration for the cluster.
--
-- /See:/ 'newKubernetesNetworkConfigRequest' smart constructor.
data KubernetesNetworkConfigRequest = KubernetesNetworkConfigRequest'
  { -- | Specify which IP family is used to assign Kubernetes pod and service IP
    -- addresses. If you don\'t specify a value, @ipv4@ is used by default. You
    -- can only specify an IP family when you create a cluster and can\'t
    -- change this value once the cluster is created. If you specify @ipv6@,
    -- the VPC and subnets that you specify for cluster creation must have both
    -- @IPv4@ and @IPv6@ CIDR blocks assigned to them. You can\'t specify
    -- @ipv6@ for clusters in China Regions.
    --
    -- You can only specify @ipv6@ for @1.21@ and later clusters that use
    -- version @1.10.1@ or later of the Amazon VPC CNI add-on. If you specify
    -- @ipv6@, then ensure that your VPC meets the requirements listed in the
    -- considerations listed in
    -- <https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html Assigning IPv6 addresses to pods and services>
    -- in the Amazon EKS User Guide. Kubernetes assigns services @IPv6@
    -- addresses from the unique local address range @(fc00::\/7)@. You can\'t
    -- specify a custom @IPv6@ CIDR block. Pod addresses are assigned from the
    -- subnet\'s @IPv6@ CIDR.
    KubernetesNetworkConfigRequest -> Maybe IpFamily
ipFamily :: Prelude.Maybe IpFamily,
    -- | Don\'t specify a value if you select @ipv6@ for __ipFamily__. The CIDR
    -- block to assign Kubernetes service IP addresses from. If you don\'t
    -- specify a block, Kubernetes assigns addresses from either the
    -- @10.100.0.0\/16@ or @172.20.0.0\/16@ CIDR blocks. We recommend that you
    -- specify a block that does not overlap with resources in other networks
    -- that are peered or connected to your VPC. The block must meet the
    -- following requirements:
    --
    -- -   Within one of the following private IP address blocks:
    --     @10.0.0.0\/8@, @172.16.0.0\/12@, or @192.168.0.0\/16@.
    --
    -- -   Doesn\'t overlap with any CIDR block assigned to the VPC that you
    --     selected for VPC.
    --
    -- -   Between \/24 and \/12.
    --
    -- You can only specify a custom CIDR block when you create a cluster and
    -- can\'t change this value once the cluster is created.
    KubernetesNetworkConfigRequest -> Maybe Text
serviceIpv4Cidr :: Prelude.Maybe Prelude.Text
  }
  deriving (KubernetesNetworkConfigRequest
-> KubernetesNetworkConfigRequest -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: KubernetesNetworkConfigRequest
-> KubernetesNetworkConfigRequest -> Bool
$c/= :: KubernetesNetworkConfigRequest
-> KubernetesNetworkConfigRequest -> Bool
== :: KubernetesNetworkConfigRequest
-> KubernetesNetworkConfigRequest -> Bool
$c== :: KubernetesNetworkConfigRequest
-> KubernetesNetworkConfigRequest -> Bool
Prelude.Eq, ReadPrec [KubernetesNetworkConfigRequest]
ReadPrec KubernetesNetworkConfigRequest
Int -> ReadS KubernetesNetworkConfigRequest
ReadS [KubernetesNetworkConfigRequest]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [KubernetesNetworkConfigRequest]
$creadListPrec :: ReadPrec [KubernetesNetworkConfigRequest]
readPrec :: ReadPrec KubernetesNetworkConfigRequest
$creadPrec :: ReadPrec KubernetesNetworkConfigRequest
readList :: ReadS [KubernetesNetworkConfigRequest]
$creadList :: ReadS [KubernetesNetworkConfigRequest]
readsPrec :: Int -> ReadS KubernetesNetworkConfigRequest
$creadsPrec :: Int -> ReadS KubernetesNetworkConfigRequest
Prelude.Read, Int -> KubernetesNetworkConfigRequest -> ShowS
[KubernetesNetworkConfigRequest] -> ShowS
KubernetesNetworkConfigRequest -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [KubernetesNetworkConfigRequest] -> ShowS
$cshowList :: [KubernetesNetworkConfigRequest] -> ShowS
show :: KubernetesNetworkConfigRequest -> String
$cshow :: KubernetesNetworkConfigRequest -> String
showsPrec :: Int -> KubernetesNetworkConfigRequest -> ShowS
$cshowsPrec :: Int -> KubernetesNetworkConfigRequest -> ShowS
Prelude.Show, forall x.
Rep KubernetesNetworkConfigRequest x
-> KubernetesNetworkConfigRequest
forall x.
KubernetesNetworkConfigRequest
-> Rep KubernetesNetworkConfigRequest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep KubernetesNetworkConfigRequest x
-> KubernetesNetworkConfigRequest
$cfrom :: forall x.
KubernetesNetworkConfigRequest
-> Rep KubernetesNetworkConfigRequest x
Prelude.Generic)

-- |
-- Create a value of 'KubernetesNetworkConfigRequest' 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:
--
-- 'ipFamily', 'kubernetesNetworkConfigRequest_ipFamily' - Specify which IP family is used to assign Kubernetes pod and service IP
-- addresses. If you don\'t specify a value, @ipv4@ is used by default. You
-- can only specify an IP family when you create a cluster and can\'t
-- change this value once the cluster is created. If you specify @ipv6@,
-- the VPC and subnets that you specify for cluster creation must have both
-- @IPv4@ and @IPv6@ CIDR blocks assigned to them. You can\'t specify
-- @ipv6@ for clusters in China Regions.
--
-- You can only specify @ipv6@ for @1.21@ and later clusters that use
-- version @1.10.1@ or later of the Amazon VPC CNI add-on. If you specify
-- @ipv6@, then ensure that your VPC meets the requirements listed in the
-- considerations listed in
-- <https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html Assigning IPv6 addresses to pods and services>
-- in the Amazon EKS User Guide. Kubernetes assigns services @IPv6@
-- addresses from the unique local address range @(fc00::\/7)@. You can\'t
-- specify a custom @IPv6@ CIDR block. Pod addresses are assigned from the
-- subnet\'s @IPv6@ CIDR.
--
-- 'serviceIpv4Cidr', 'kubernetesNetworkConfigRequest_serviceIpv4Cidr' - Don\'t specify a value if you select @ipv6@ for __ipFamily__. The CIDR
-- block to assign Kubernetes service IP addresses from. If you don\'t
-- specify a block, Kubernetes assigns addresses from either the
-- @10.100.0.0\/16@ or @172.20.0.0\/16@ CIDR blocks. We recommend that you
-- specify a block that does not overlap with resources in other networks
-- that are peered or connected to your VPC. The block must meet the
-- following requirements:
--
-- -   Within one of the following private IP address blocks:
--     @10.0.0.0\/8@, @172.16.0.0\/12@, or @192.168.0.0\/16@.
--
-- -   Doesn\'t overlap with any CIDR block assigned to the VPC that you
--     selected for VPC.
--
-- -   Between \/24 and \/12.
--
-- You can only specify a custom CIDR block when you create a cluster and
-- can\'t change this value once the cluster is created.
newKubernetesNetworkConfigRequest ::
  KubernetesNetworkConfigRequest
newKubernetesNetworkConfigRequest :: KubernetesNetworkConfigRequest
newKubernetesNetworkConfigRequest =
  KubernetesNetworkConfigRequest'
    { $sel:ipFamily:KubernetesNetworkConfigRequest' :: Maybe IpFamily
ipFamily =
        forall a. Maybe a
Prelude.Nothing,
      $sel:serviceIpv4Cidr:KubernetesNetworkConfigRequest' :: Maybe Text
serviceIpv4Cidr = forall a. Maybe a
Prelude.Nothing
    }

-- | Specify which IP family is used to assign Kubernetes pod and service IP
-- addresses. If you don\'t specify a value, @ipv4@ is used by default. You
-- can only specify an IP family when you create a cluster and can\'t
-- change this value once the cluster is created. If you specify @ipv6@,
-- the VPC and subnets that you specify for cluster creation must have both
-- @IPv4@ and @IPv6@ CIDR blocks assigned to them. You can\'t specify
-- @ipv6@ for clusters in China Regions.
--
-- You can only specify @ipv6@ for @1.21@ and later clusters that use
-- version @1.10.1@ or later of the Amazon VPC CNI add-on. If you specify
-- @ipv6@, then ensure that your VPC meets the requirements listed in the
-- considerations listed in
-- <https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html Assigning IPv6 addresses to pods and services>
-- in the Amazon EKS User Guide. Kubernetes assigns services @IPv6@
-- addresses from the unique local address range @(fc00::\/7)@. You can\'t
-- specify a custom @IPv6@ CIDR block. Pod addresses are assigned from the
-- subnet\'s @IPv6@ CIDR.
kubernetesNetworkConfigRequest_ipFamily :: Lens.Lens' KubernetesNetworkConfigRequest (Prelude.Maybe IpFamily)
kubernetesNetworkConfigRequest_ipFamily :: Lens' KubernetesNetworkConfigRequest (Maybe IpFamily)
kubernetesNetworkConfigRequest_ipFamily = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\KubernetesNetworkConfigRequest' {Maybe IpFamily
ipFamily :: Maybe IpFamily
$sel:ipFamily:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe IpFamily
ipFamily} -> Maybe IpFamily
ipFamily) (\s :: KubernetesNetworkConfigRequest
s@KubernetesNetworkConfigRequest' {} Maybe IpFamily
a -> KubernetesNetworkConfigRequest
s {$sel:ipFamily:KubernetesNetworkConfigRequest' :: Maybe IpFamily
ipFamily = Maybe IpFamily
a} :: KubernetesNetworkConfigRequest)

-- | Don\'t specify a value if you select @ipv6@ for __ipFamily__. The CIDR
-- block to assign Kubernetes service IP addresses from. If you don\'t
-- specify a block, Kubernetes assigns addresses from either the
-- @10.100.0.0\/16@ or @172.20.0.0\/16@ CIDR blocks. We recommend that you
-- specify a block that does not overlap with resources in other networks
-- that are peered or connected to your VPC. The block must meet the
-- following requirements:
--
-- -   Within one of the following private IP address blocks:
--     @10.0.0.0\/8@, @172.16.0.0\/12@, or @192.168.0.0\/16@.
--
-- -   Doesn\'t overlap with any CIDR block assigned to the VPC that you
--     selected for VPC.
--
-- -   Between \/24 and \/12.
--
-- You can only specify a custom CIDR block when you create a cluster and
-- can\'t change this value once the cluster is created.
kubernetesNetworkConfigRequest_serviceIpv4Cidr :: Lens.Lens' KubernetesNetworkConfigRequest (Prelude.Maybe Prelude.Text)
kubernetesNetworkConfigRequest_serviceIpv4Cidr :: Lens' KubernetesNetworkConfigRequest (Maybe Text)
kubernetesNetworkConfigRequest_serviceIpv4Cidr = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\KubernetesNetworkConfigRequest' {Maybe Text
serviceIpv4Cidr :: Maybe Text
$sel:serviceIpv4Cidr:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe Text
serviceIpv4Cidr} -> Maybe Text
serviceIpv4Cidr) (\s :: KubernetesNetworkConfigRequest
s@KubernetesNetworkConfigRequest' {} Maybe Text
a -> KubernetesNetworkConfigRequest
s {$sel:serviceIpv4Cidr:KubernetesNetworkConfigRequest' :: Maybe Text
serviceIpv4Cidr = Maybe Text
a} :: KubernetesNetworkConfigRequest)

instance
  Prelude.Hashable
    KubernetesNetworkConfigRequest
  where
  hashWithSalt :: Int -> KubernetesNetworkConfigRequest -> Int
hashWithSalt
    Int
_salt
    KubernetesNetworkConfigRequest' {Maybe Text
Maybe IpFamily
serviceIpv4Cidr :: Maybe Text
ipFamily :: Maybe IpFamily
$sel:serviceIpv4Cidr:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe Text
$sel:ipFamily:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe IpFamily
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe IpFamily
ipFamily
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
serviceIpv4Cidr

instance
  Prelude.NFData
    KubernetesNetworkConfigRequest
  where
  rnf :: KubernetesNetworkConfigRequest -> ()
rnf KubernetesNetworkConfigRequest' {Maybe Text
Maybe IpFamily
serviceIpv4Cidr :: Maybe Text
ipFamily :: Maybe IpFamily
$sel:serviceIpv4Cidr:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe Text
$sel:ipFamily:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe IpFamily
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe IpFamily
ipFamily
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
serviceIpv4Cidr

instance Data.ToJSON KubernetesNetworkConfigRequest where
  toJSON :: KubernetesNetworkConfigRequest -> Value
toJSON KubernetesNetworkConfigRequest' {Maybe Text
Maybe IpFamily
serviceIpv4Cidr :: Maybe Text
ipFamily :: Maybe IpFamily
$sel:serviceIpv4Cidr:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe Text
$sel:ipFamily:KubernetesNetworkConfigRequest' :: KubernetesNetworkConfigRequest -> Maybe IpFamily
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ipFamily" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe IpFamily
ipFamily,
            (Key
"serviceIpv4Cidr" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
serviceIpv4Cidr
          ]
      )