Packages

class Builder extends AnyRef

Builder for SparkAWSCredentials instances.

Source
SparkAWSCredentials.scala
Since

2.2.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Builder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Builder()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def basicCredentials(accessKeyId: String, secretKey: String): Builder

    Use a basic AWS keypair for long-lived authorization.

    Use a basic AWS keypair for long-lived authorization.

    accessKeyId

    AWS access key ID

    secretKey

    AWS secret key

    returns

    Reference to this SparkAWSCredentials.Builder

    Note

    The given AWS keypair will be saved in DStream checkpoints if checkpointing is enabled. Make sure that your checkpoint directory is secure. Prefer using the default provider chain instead if possible (http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default).

  6. def build(): SparkAWSCredentials

    Returns the appropriate instance of SparkAWSCredentials given the configured parameters.

    Returns the appropriate instance of SparkAWSCredentials given the configured parameters.

    - The long-lived credentials will either be DefaultCredentials or BasicCredentials if they were provided.

    - If STS credentials were provided, the configured long-lived credentials will be added to them and the result will be returned.

    - The long-lived credentials will be returned otherwise.

    returns

    SparkAWSCredentials to use for configured parameters

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. def stsCredentials(roleArn: String, sessionName: String, externalId: String): Builder

    Use STS to assume an IAM role for temporary session-based authentication.

    Use STS to assume an IAM role for temporary session-based authentication. Will use configured long-lived credentials for authorizing to STS itself (either the default provider chain or a configured keypair). STS will validate the provided external ID with the one defined in the trust policy of the IAM role to be assumed (if one is present).

    roleArn

    ARN of IAM role to assume via STS

    sessionName

    Name to use for the STS session

    externalId

    External ID to validate against assumed IAM role's trust policy

    returns

    Reference to this SparkAWSCredentials.Builder

  17. def stsCredentials(roleArn: String, sessionName: String): Builder

    Use STS to assume an IAM role for temporary session-based authentication.

    Use STS to assume an IAM role for temporary session-based authentication. Will use configured long-lived credentials for authorizing to STS itself (either the default provider chain or a configured keypair).

    roleArn

    ARN of IAM role to assume via STS

    sessionName

    Name to use for the STS session

    returns

    Reference to this SparkAWSCredentials.Builder

  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped