kinesis4cats.models.StreamArn.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kinesis4cats-shared_native0.4_3 Show documentation
Common shared utilities
The newest version!
/*
 * Copyright 2023-2023 etspaceman
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package kinesis4cats.models

import scala.util.Try

import cats.syntax.all._

/** Helper class for constructing and representing Kinesis stream ARN values
  *
  * @param awsRegion
  *   [[kinesis4cats.models.AwsRegion AwsRegion]]
  * @param streamName
  *   Name of stream
  * @param awsAccountId
  *   12 digit AWS account ID. For Localstack, this is all 0s
  */
final case class StreamArn(
    awsRegion: AwsRegion,
    streamName: String,
    awsAccountId: String
) {
  val streamArn =
    s"arn:${awsRegion.awsArnPiece}:kinesis:${awsRegion.name}:$awsAccountId:stream/$streamName"

  override def toString(): String = streamArn
}

object StreamArn {

  /** Parses an AWS ARN string into a
    * [[kinesis4cats.models.StreamArn StreamArn]]
    *
    * @param streamArn
    *   AWS ARN of the Stream to parse
    * @return
    *   Either [[kinesis4cats.models.StreamArn StreamArn]] or a string with an
    *   error message
    */
  def fromArn(streamArn: String): Either[String, StreamArn] =
    for {
      streamName <- Try(streamArn.split("/")(1)).toEither.leftMap(e =>
        s"Could not get stream name from ARN: ${e.getMessage}"
      )
      streamParts = streamArn.split(":")
      awsRegion <- Try(streamParts(3)).toEither
        .leftMap(_.getMessage)
        .flatMap(region =>
          Either.fromOption(
            AwsRegion.values
              .find(_.name == region),
            s"Could not get awsRegion from ARN. $region is not recognized as a valid region."
          )
        )
      awsAccountId <- Try(streamParts(4)).toEither.leftMap(e =>
        s"Could not get awsAccountId from ARN: ${e.getMessage}"
      )
    } yield StreamArn(awsRegion, streamName, awsAccountId)
}