Fixes #107 - Added some scala doc

AbsaOSS · Nov 30, 2023 · f98b794 · f98b794
1 parent dd857f1
commit f98b794
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/server/src/main/scala/za/co/absa/atum/server/api/RetrieveAwsSecret.scala b/server/src/main/scala/za/co/absa/atum/server/api/RetrieveAwsSecret.scala
@@ -20,11 +20,19 @@ import software.amazon.awssdk.regions.Region
 import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient
 import software.amazon.awssdk.services.secretsmanager.model.{GetSecretValueRequest, SecretsManagerException}
 
+/**
+ * Class implement the functionality of retrieving secret keys from aws secret manger service
+ */
 class RetrieveAwsSecret {
   private val secretsManagerClient: SecretsManagerClient = SecretsManagerClient.builder()
     .region(Region.AF_SOUTH_1)
     .build()
 
+  /**
+   * Function retrieves secret keys from aws
+   * @param secretName
+   * @return
+   */
   def retrieveAwsSecret(secretName: String = "atum_user"): Seq[String] = {
     try {
       val request = GetSecretValueRequest.builder()