RemoteAccessConfig.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.EKS.Types.RemoteAccessConfig
-- 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.RemoteAccessConfig 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

-- | An object representing the remote access configuration for the managed
-- node group.
--
-- /See:/ 'newRemoteAccessConfig' smart constructor.
data RemoteAccessConfig = RemoteAccessConfig'
  { -- | The Amazon EC2 SSH key name that provides access for SSH communication
    -- with the nodes in the managed node group. For more information, see
    -- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html Amazon EC2 key pairs and Linux instances>
    -- in the /Amazon Elastic Compute Cloud User Guide for Linux Instances/.
    -- For Windows, an Amazon EC2 SSH key is used to obtain the RDP password.
    -- For more information, see
    -- <https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html Amazon EC2 key pairs and Windows instances>
    -- in the /Amazon Elastic Compute Cloud User Guide for Windows Instances/.
    ec2SshKey :: Prelude.Maybe Prelude.Text,
    -- | The security group IDs that are allowed SSH access (port 22) to the
    -- nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH
    -- key but don\'t specify a source security group when you create a managed
    -- node group, then the port on the nodes is opened to the internet
    -- (@0.0.0.0\/0@). For more information, see
    -- <https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html Security Groups for Your VPC>
    -- in the /Amazon Virtual Private Cloud User Guide/.
    sourceSecurityGroups :: Prelude.Maybe [Prelude.Text]
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'RemoteAccessConfig' 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:
--
-- 'ec2SshKey', 'remoteAccessConfig_ec2SshKey' - The Amazon EC2 SSH key name that provides access for SSH communication
-- with the nodes in the managed node group. For more information, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html Amazon EC2 key pairs and Linux instances>
-- in the /Amazon Elastic Compute Cloud User Guide for Linux Instances/.
-- For Windows, an Amazon EC2 SSH key is used to obtain the RDP password.
-- For more information, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html Amazon EC2 key pairs and Windows instances>
-- in the /Amazon Elastic Compute Cloud User Guide for Windows Instances/.
--
-- 'sourceSecurityGroups', 'remoteAccessConfig_sourceSecurityGroups' - The security group IDs that are allowed SSH access (port 22) to the
-- nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH
-- key but don\'t specify a source security group when you create a managed
-- node group, then the port on the nodes is opened to the internet
-- (@0.0.0.0\/0@). For more information, see
-- <https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html Security Groups for Your VPC>
-- in the /Amazon Virtual Private Cloud User Guide/.
newRemoteAccessConfig ::
  RemoteAccessConfig
newRemoteAccessConfig =
  RemoteAccessConfig'
    { ec2SshKey = Prelude.Nothing,
      sourceSecurityGroups = Prelude.Nothing
    }

-- | The Amazon EC2 SSH key name that provides access for SSH communication
-- with the nodes in the managed node group. For more information, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html Amazon EC2 key pairs and Linux instances>
-- in the /Amazon Elastic Compute Cloud User Guide for Linux Instances/.
-- For Windows, an Amazon EC2 SSH key is used to obtain the RDP password.
-- For more information, see
-- <https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html Amazon EC2 key pairs and Windows instances>
-- in the /Amazon Elastic Compute Cloud User Guide for Windows Instances/.
remoteAccessConfig_ec2SshKey :: Lens.Lens' RemoteAccessConfig (Prelude.Maybe Prelude.Text)
remoteAccessConfig_ec2SshKey = Lens.lens (\RemoteAccessConfig' {ec2SshKey} -> ec2SshKey) (\s@RemoteAccessConfig' {} a -> s {ec2SshKey = a} :: RemoteAccessConfig)

-- | The security group IDs that are allowed SSH access (port 22) to the
-- nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH
-- key but don\'t specify a source security group when you create a managed
-- node group, then the port on the nodes is opened to the internet
-- (@0.0.0.0\/0@). For more information, see
-- <https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html Security Groups for Your VPC>
-- in the /Amazon Virtual Private Cloud User Guide/.
remoteAccessConfig_sourceSecurityGroups :: Lens.Lens' RemoteAccessConfig (Prelude.Maybe [Prelude.Text])
remoteAccessConfig_sourceSecurityGroups = Lens.lens (\RemoteAccessConfig' {sourceSecurityGroups} -> sourceSecurityGroups) (\s@RemoteAccessConfig' {} a -> s {sourceSecurityGroups = a} :: RemoteAccessConfig) Prelude.. Lens.mapping Lens.coerced

instance Data.FromJSON RemoteAccessConfig where
  parseJSON =
    Data.withObject
      "RemoteAccessConfig"
      ( \x ->
          RemoteAccessConfig'
            Prelude.<$> (x Data..:? "ec2SshKey")
            Prelude.<*> ( x
                            Data..:? "sourceSecurityGroups"
                            Data..!= Prelude.mempty
                        )
      )

instance Prelude.Hashable RemoteAccessConfig where
  hashWithSalt _salt RemoteAccessConfig' {..} =
    _salt
      `Prelude.hashWithSalt` ec2SshKey
      `Prelude.hashWithSalt` sourceSecurityGroups

instance Prelude.NFData RemoteAccessConfig where
  rnf RemoteAccessConfig' {..} =
    Prelude.rnf ec2SshKey
      `Prelude.seq` Prelude.rnf sourceSecurityGroups

instance Data.ToJSON RemoteAccessConfig where
  toJSON RemoteAccessConfig' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("ec2SshKey" Data..=) Prelude.<$> ec2SshKey,
            ("sourceSecurityGroups" Data..=)
              Prelude.<$> sourceSecurityGroups
          ]
      )