Packages

final case class Role(dbName: String, creationStatementsJson: JsonObject, defaultTtl: Duration, maxTtl: Duration) extends BaseRole with Product with Serializable

dbName

the name of the database connection to use for this role.

creationStatementsJson

Using JSON, either defines an elasticsearch_role_definition or a group of pre-existing elasticsearch_roles. The object specified by the elasticsearch_role_definition is the JSON directly passed through to the Elasticsearch API, so you can pass through anything shown here.

defaultTtl

the TTL for the leases associated with this role. Defaults to system/engine default TTL time.

maxTtl

the maximum TTL for the leases associated with this role. Defaults to system/mount default TTL time; this value is allowed to be less than the mount max TTL (or, if not set, the system max TTL), but it is not allowed to be longer.

Source
Role.scala
See also

RoleDefinition For elasticsearch_roles, add the names of the roles only. They must pre-exist in Elasticsearch. Defining roles in Vault is more secure than using pre-existing roles because a privilege escalation could be performed by editing the roles used out-of-band in Elasticsearch.

See also The TTL General Case.

Linear Supertypes
Serializable, Product, Equals, BaseRole, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Role
  2. Serializable
  3. Product
  4. Equals
  5. BaseRole
  6. AnyRef
  7. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Role(dbName: String, creationStatementsJson: JsonObject, defaultTtl: Duration, maxTtl: Duration)

    dbName

    the name of the database connection to use for this role.

    creationStatementsJson

    Using JSON, either defines an elasticsearch_role_definition or a group of pre-existing elasticsearch_roles. The object specified by the elasticsearch_role_definition is the JSON directly passed through to the Elasticsearch API, so you can pass through anything shown here.

    defaultTtl

    the TTL for the leases associated with this role. Defaults to system/engine default TTL time.

    maxTtl

    the maximum TTL for the leases associated with this role. Defaults to system/mount default TTL time; this value is allowed to be less than the mount max TTL (or, if not set, the system max TTL), but it is not allowed to be longer.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Role, B)
    Implicit
    This member is added by an implicit conversion from Role toArrowAssoc[Role] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  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. val creationStatements: List[String]

    The database statements executed to create and configure a user.

    The database statements executed to create and configure a user.

    Definition Classes
    Role → BaseRole
  8. val creationStatementsJson: JsonObject
  9. val dbName: String

    The name of the database connection to use for this role.

    The name of the database connection to use for this role.

    Definition Classes
    Role → BaseRole
  10. val defaultTtl: Duration

    The TTL for the leases associated with this role.

    The TTL for the leases associated with this role. Defaults to system/engine default TTL time.

    Definition Classes
    Role → BaseRole
  11. def ensuring(cond: (Role) => Boolean, msg: => Any): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Role) => Boolean): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Role toStringFormat[Role] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val maxTtl: Duration

    The maximum TTL for the leases associated with this role.

    The maximum TTL for the leases associated with this role. Defaults to system/mount default TTL time; this value is allowed to be less than the mount max TTL (or, if not set, the system max TTL), but it is not allowed to be longer.

    Definition Classes
    Role → BaseRole
    See also

    See also The TTL General Case

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (Role, B)
    Implicit
    This member is added by an implicit conversion from Role toArrowAssoc[Role] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BaseRole

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromRole to StringFormat[Role]

Inherited by implicit conversion Ensuring fromRole to Ensuring[Role]

Inherited by implicit conversion ArrowAssoc fromRole to ArrowAssoc[Role]

Ungrouped