Github user brkyvz commented on a diff in the pull request:
https://github.com/apache/spark/pull/17250#discussion_r107976590
--- Diff:
external/kinesis-asl/src/main/scala/org/apache/spark/streaming/kinesis/SparkAWSCredentials.scala
---
@@ -0,0 +1,179 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.spark.streaming.kinesis
+
+import scala.collection.JavaConverters._
+
+import com.amazonaws.auth._
+
+import org.apache.spark.annotation.InterfaceStability
+import org.apache.spark.internal.Logging
+
+/**
+ * Serializable interface providing a method executors can call to obtain
an
+ * AWSCredentialsProvider instance for authenticating to AWS services.
+ */
+private[kinesis] sealed trait SparkAWSCredentials extends Serializable {
+ /**
+ * Return an AWSCredentialProvider instance that can be used by the
Kinesis Client
+ * Library to authenticate to AWS services (Kinesis, CloudWatch and
DynamoDB).
+ */
+ def provider: AWSCredentialsProvider
+}
+
+/** Returns DefaultAWSCredentialsProviderChain for authentication. */
+private[kinesis] final case object DefaultCredentials extends
SparkAWSCredentials {
+
+ def provider: AWSCredentialsProvider = new
DefaultAWSCredentialsProviderChain
+}
+
+/**
+ * Returns AWSStaticCredentialsProvider constructed using basic AWS
keypair. Falls back to using
+ * DefaultCredentialsProviderChain if unable to construct a
AWSCredentialsProviderChain
+ * instance with the provided arguments (e.g. if they are null).
+ */
+private[kinesis] final case class BasicCredentials(
+ awsAccessKeyId: String,
+ awsSecretKey: String) extends SparkAWSCredentials with Logging {
+
+ def provider: AWSCredentialsProvider = try {
+ new AWSStaticCredentialsProvider(new
BasicAWSCredentials(awsAccessKeyId, awsSecretKey))
+ } catch {
+ case e: IllegalArgumentException =>
+ logWarning("Unable to construct AWSStaticCredentialsProvider with
provided keypair; " +
+ "falling back to DefaultCredentialsProviderChain.", e)
+ new DefaultAWSCredentialsProviderChain
+ }
+}
+
+/**
+ * Returns an STSAssumeRoleSessionCredentialsProvider instance which
assumes an IAM
+ * role in order to authenticate against resources in an external account.
+ */
+private[kinesis] final case class STSCredentials(
+ stsRoleArn: String,
+ stsSessionName: String,
+ stsExternalId: Option[String] = None,
+ longLivedCreds: SparkAWSCredentials = DefaultCredentials)
+ extends SparkAWSCredentials {
+
+ def provider: AWSCredentialsProvider = {
+ val builder = new
STSAssumeRoleSessionCredentialsProvider.Builder(stsRoleArn, stsSessionName)
+ .withLongLivedCredentialsProvider(longLivedCreds.provider)
+ stsExternalId match {
+ case Some(stsExternalId) =>
+ builder.withExternalId(stsExternalId)
+ .build()
+ case None =>
+ builder.build()
+ }
+ }
+}
+
+@InterfaceStability.Evolving
+object SparkAWSCredentials {
+ /**
+ * Builder for [[SparkAWSCredentials]] instances.
+ *
+ * @since 2.2.0
+ */
+ @InterfaceStability.Evolving
+ class Builder {
+ private var basicCreds: Option[BasicCredentials] = None
+ private var stsCreds: Option[STSCredentials] = None
+
+ /**
+ * Use a basic AWS keypair for long-lived authorization.
+ *
+ * @note The given AWS keypair will be saved in DStream checkpoints if
checkpointing is
+ * enabled. Make sure that your checkpoint directory is secure if
using the default
--- End diff --
Feel free to add
```
// scalastyle: off
// scalastyle: on
```
around the doc
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
