t

com.databricks.sdk.scala.dbutils

DatabricksCredentialUtils

trait DatabricksCredentialUtils extends Serializable with WithHelpMethods

Provides utilities for interacting with credentials within notebooks. Only usable on clusters with credential passthrough enabled. IAM credential passthrough is a legacy data governance model. Databricks recommends that you upgrade to Unity Catalog. Unity Catalog simplifies security and governance of your data by providing a central place to administer and audit data access across multiple workspaces in your account. For more information, please consult the Databricks documentation.

Linear Supertypes
WithHelpMethods, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DatabricksCredentialUtils
  2. WithHelpMethods
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def assumeRole(role: String): Boolean

    Sets the role ARN to assume when looking for credentials to authenticate with S3.

    Sets the role ARN to assume when looking for credentials to authenticate with S3. See what roles are available with dbutils.credentials.showRoles(). If you try to assume a role that is not available to you nothing will happen. Only usable on clusters with credential passthrough enabled.

    Example:

    dbutils.credentials.assumeRole("arn:aws:iam::123456789012:group/Developers")
    role

    The role to assume

  2. abstract def help(moduleOrMethod: String): Unit
    Definition Classes
    WithHelpMethods
  3. abstract def help(): Unit
    Definition Classes
    WithHelpMethods
  4. abstract def showCurrentRole(): List[String]

    Shows the currently set role.

    Shows the currently set role. Only usable on clusters with credential passthrough enabled.

    Example:

    dbutils.credentials.showCurrentRole()
  5. abstract def showRoles(): List[String]

    Shows the set of possibly assumed roles.

    Shows the set of possibly assumed roles. Only usable on clusters with credential passthrough enabled.

    Example:

    dbutils.credentials.showRoles()

Concrete 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 apply(): DatabricksCredentialUtils.this.type
    Definition Classes
    WithHelpMethods
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @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
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from WithHelpMethods

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped