NeptuneSettings.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.DMS.Types.NeptuneSettings
-- 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.DMS.Types.NeptuneSettings 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

-- | Provides information that defines an Amazon Neptune endpoint.
--
-- /See:/ 'newNeptuneSettings' smart constructor.
data NeptuneSettings = NeptuneSettings'
  { -- | The number of milliseconds for DMS to wait to retry a bulk-load of
    -- migrated graph data to the Neptune target database before raising an
    -- error. The default is 250.
    errorRetryDuration :: Prelude.Maybe Prelude.Int,
    -- | If you want Identity and Access Management (IAM) authorization enabled
    -- for this endpoint, set this parameter to @true@. Then attach the
    -- appropriate IAM policy document to your service role specified by
    -- @ServiceAccessRoleArn@. The default is @false@.
    iamAuthEnabled :: Prelude.Maybe Prelude.Bool,
    -- | The maximum size in kilobytes of migrated graph data stored in a .csv
    -- file before DMS bulk-loads the data to the Neptune target database. The
    -- default is 1,048,576 KB. If the bulk load is successful, DMS clears the
    -- bucket, ready to store the next batch of migrated graph data.
    maxFileSize :: Prelude.Maybe Prelude.Int,
    -- | The number of times for DMS to retry a bulk load of migrated graph data
    -- to the Neptune target database before raising an error. The default is
    -- 5.
    maxRetryCount :: Prelude.Maybe Prelude.Int,
    -- | The Amazon Resource Name (ARN) of the service role that you created for
    -- the Neptune target endpoint. The role must allow the @iam:PassRole@
    -- action. For more information, see
    -- <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole Creating an IAM Service Role for Accessing Amazon Neptune as a Target>
    -- in the /Database Migration Service User Guide./
    serviceAccessRoleArn :: Prelude.Maybe Prelude.Text,
    -- | The name of the Amazon S3 bucket where DMS can temporarily store
    -- migrated graph data in .csv files before bulk-loading it to the Neptune
    -- target database. DMS maps the SQL source data to graph data before
    -- storing it in these .csv files.
    s3BucketName :: Prelude.Text,
    -- | A folder path where you want DMS to store migrated graph data in the S3
    -- bucket specified by @S3BucketName@
    s3BucketFolder :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'NeptuneSettings' 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:
--
-- 'errorRetryDuration', 'neptuneSettings_errorRetryDuration' - The number of milliseconds for DMS to wait to retry a bulk-load of
-- migrated graph data to the Neptune target database before raising an
-- error. The default is 250.
--
-- 'iamAuthEnabled', 'neptuneSettings_iamAuthEnabled' - If you want Identity and Access Management (IAM) authorization enabled
-- for this endpoint, set this parameter to @true@. Then attach the
-- appropriate IAM policy document to your service role specified by
-- @ServiceAccessRoleArn@. The default is @false@.
--
-- 'maxFileSize', 'neptuneSettings_maxFileSize' - The maximum size in kilobytes of migrated graph data stored in a .csv
-- file before DMS bulk-loads the data to the Neptune target database. The
-- default is 1,048,576 KB. If the bulk load is successful, DMS clears the
-- bucket, ready to store the next batch of migrated graph data.
--
-- 'maxRetryCount', 'neptuneSettings_maxRetryCount' - The number of times for DMS to retry a bulk load of migrated graph data
-- to the Neptune target database before raising an error. The default is
-- 5.
--
-- 'serviceAccessRoleArn', 'neptuneSettings_serviceAccessRoleArn' - The Amazon Resource Name (ARN) of the service role that you created for
-- the Neptune target endpoint. The role must allow the @iam:PassRole@
-- action. For more information, see
-- <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole Creating an IAM Service Role for Accessing Amazon Neptune as a Target>
-- in the /Database Migration Service User Guide./
--
-- 's3BucketName', 'neptuneSettings_s3BucketName' - The name of the Amazon S3 bucket where DMS can temporarily store
-- migrated graph data in .csv files before bulk-loading it to the Neptune
-- target database. DMS maps the SQL source data to graph data before
-- storing it in these .csv files.
--
-- 's3BucketFolder', 'neptuneSettings_s3BucketFolder' - A folder path where you want DMS to store migrated graph data in the S3
-- bucket specified by @S3BucketName@
newNeptuneSettings ::
  -- | 's3BucketName'
  Prelude.Text ->
  -- | 's3BucketFolder'
  Prelude.Text ->
  NeptuneSettings
newNeptuneSettings pS3BucketName_ pS3BucketFolder_ =
  NeptuneSettings'
    { errorRetryDuration =
        Prelude.Nothing,
      iamAuthEnabled = Prelude.Nothing,
      maxFileSize = Prelude.Nothing,
      maxRetryCount = Prelude.Nothing,
      serviceAccessRoleArn = Prelude.Nothing,
      s3BucketName = pS3BucketName_,
      s3BucketFolder = pS3BucketFolder_
    }

-- | The number of milliseconds for DMS to wait to retry a bulk-load of
-- migrated graph data to the Neptune target database before raising an
-- error. The default is 250.
neptuneSettings_errorRetryDuration :: Lens.Lens' NeptuneSettings (Prelude.Maybe Prelude.Int)
neptuneSettings_errorRetryDuration = Lens.lens (\NeptuneSettings' {errorRetryDuration} -> errorRetryDuration) (\s@NeptuneSettings' {} a -> s {errorRetryDuration = a} :: NeptuneSettings)

-- | If you want Identity and Access Management (IAM) authorization enabled
-- for this endpoint, set this parameter to @true@. Then attach the
-- appropriate IAM policy document to your service role specified by
-- @ServiceAccessRoleArn@. The default is @false@.
neptuneSettings_iamAuthEnabled :: Lens.Lens' NeptuneSettings (Prelude.Maybe Prelude.Bool)
neptuneSettings_iamAuthEnabled = Lens.lens (\NeptuneSettings' {iamAuthEnabled} -> iamAuthEnabled) (\s@NeptuneSettings' {} a -> s {iamAuthEnabled = a} :: NeptuneSettings)

-- | The maximum size in kilobytes of migrated graph data stored in a .csv
-- file before DMS bulk-loads the data to the Neptune target database. The
-- default is 1,048,576 KB. If the bulk load is successful, DMS clears the
-- bucket, ready to store the next batch of migrated graph data.
neptuneSettings_maxFileSize :: Lens.Lens' NeptuneSettings (Prelude.Maybe Prelude.Int)
neptuneSettings_maxFileSize = Lens.lens (\NeptuneSettings' {maxFileSize} -> maxFileSize) (\s@NeptuneSettings' {} a -> s {maxFileSize = a} :: NeptuneSettings)

-- | The number of times for DMS to retry a bulk load of migrated graph data
-- to the Neptune target database before raising an error. The default is
-- 5.
neptuneSettings_maxRetryCount :: Lens.Lens' NeptuneSettings (Prelude.Maybe Prelude.Int)
neptuneSettings_maxRetryCount = Lens.lens (\NeptuneSettings' {maxRetryCount} -> maxRetryCount) (\s@NeptuneSettings' {} a -> s {maxRetryCount = a} :: NeptuneSettings)

-- | The Amazon Resource Name (ARN) of the service role that you created for
-- the Neptune target endpoint. The role must allow the @iam:PassRole@
-- action. For more information, see
-- <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole Creating an IAM Service Role for Accessing Amazon Neptune as a Target>
-- in the /Database Migration Service User Guide./
neptuneSettings_serviceAccessRoleArn :: Lens.Lens' NeptuneSettings (Prelude.Maybe Prelude.Text)
neptuneSettings_serviceAccessRoleArn = Lens.lens (\NeptuneSettings' {serviceAccessRoleArn} -> serviceAccessRoleArn) (\s@NeptuneSettings' {} a -> s {serviceAccessRoleArn = a} :: NeptuneSettings)

-- | The name of the Amazon S3 bucket where DMS can temporarily store
-- migrated graph data in .csv files before bulk-loading it to the Neptune
-- target database. DMS maps the SQL source data to graph data before
-- storing it in these .csv files.
neptuneSettings_s3BucketName :: Lens.Lens' NeptuneSettings Prelude.Text
neptuneSettings_s3BucketName = Lens.lens (\NeptuneSettings' {s3BucketName} -> s3BucketName) (\s@NeptuneSettings' {} a -> s {s3BucketName = a} :: NeptuneSettings)

-- | A folder path where you want DMS to store migrated graph data in the S3
-- bucket specified by @S3BucketName@
neptuneSettings_s3BucketFolder :: Lens.Lens' NeptuneSettings Prelude.Text
neptuneSettings_s3BucketFolder = Lens.lens (\NeptuneSettings' {s3BucketFolder} -> s3BucketFolder) (\s@NeptuneSettings' {} a -> s {s3BucketFolder = a} :: NeptuneSettings)

instance Data.FromJSON NeptuneSettings where
  parseJSON =
    Data.withObject
      "NeptuneSettings"
      ( \x ->
          NeptuneSettings'
            Prelude.<$> (x Data..:? "ErrorRetryDuration")
            Prelude.<*> (x Data..:? "IamAuthEnabled")
            Prelude.<*> (x Data..:? "MaxFileSize")
            Prelude.<*> (x Data..:? "MaxRetryCount")
            Prelude.<*> (x Data..:? "ServiceAccessRoleArn")
            Prelude.<*> (x Data..: "S3BucketName")
            Prelude.<*> (x Data..: "S3BucketFolder")
      )

instance Prelude.Hashable NeptuneSettings where
  hashWithSalt _salt NeptuneSettings' {..} =
    _salt
      `Prelude.hashWithSalt` errorRetryDuration
      `Prelude.hashWithSalt` iamAuthEnabled
      `Prelude.hashWithSalt` maxFileSize
      `Prelude.hashWithSalt` maxRetryCount
      `Prelude.hashWithSalt` serviceAccessRoleArn
      `Prelude.hashWithSalt` s3BucketName
      `Prelude.hashWithSalt` s3BucketFolder

instance Prelude.NFData NeptuneSettings where
  rnf NeptuneSettings' {..} =
    Prelude.rnf errorRetryDuration
      `Prelude.seq` Prelude.rnf iamAuthEnabled
      `Prelude.seq` Prelude.rnf maxFileSize
      `Prelude.seq` Prelude.rnf maxRetryCount
      `Prelude.seq` Prelude.rnf serviceAccessRoleArn
      `Prelude.seq` Prelude.rnf s3BucketName
      `Prelude.seq` Prelude.rnf s3BucketFolder

instance Data.ToJSON NeptuneSettings where
  toJSON NeptuneSettings' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("ErrorRetryDuration" Data..=)
              Prelude.<$> errorRetryDuration,
            ("IamAuthEnabled" Data..=)
              Prelude.<$> iamAuthEnabled,
            ("MaxFileSize" Data..=) Prelude.<$> maxFileSize,
            ("MaxRetryCount" Data..=) Prelude.<$> maxRetryCount,
            ("ServiceAccessRoleArn" Data..=)
              Prelude.<$> serviceAccessRoleArn,
            Prelude.Just ("S3BucketName" Data..= s3BucketName),
            Prelude.Just
              ("S3BucketFolder" Data..= s3BucketFolder)
          ]
      )