class Builder extends AnyRef
Builder for SparkAWSCredentials instances.
- Annotations
 - @Evolving()
 - Since
 2.2.0
- Alphabetic
 - By Inheritance
 
- Builder
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - All
 
Instance Constructors
-  new Builder()
 
Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        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.
 - 
      
      
      
        
      
    
      
        
        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
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
- Attributes
 - protected[java.lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @native() @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      
- Attributes
 - protected[java.lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( classOf[java.lang.Throwable] )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        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
 - 
      
      
      
        
      
    
      
        
        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
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native() @throws( ... )