case class Role(dbName: String, creationStatementsJson: JsonObject, revocationStatementsJson: JsonObject, defaultTtl: Duration, maxTtl: Duration) extends BaseRole with Product with Serializable
- dbName
the name of the database connection to use for this role.
- creationStatementsJson
Specifies the database statements executed to create and configure a user. The object can optionally contain a "db" string for session connection, and must contain a "roles" array. This array contains objects that holds a "role", and an optional "db" value, and is similar to the BSON document that is accepted by MongoDB's roles field. Vault will transform this array into such format. For more information regarding the roles field, refer to MongoDB's documentation.
- revocationStatementsJson
Specifies the database statements to be executed to revoke a user. The object can optionally contain a "db" string. If no "db" value is provided, it defaults to the "admin" database.
- 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
See also The TTL General Case.
- Alphabetic
- By Inheritance
- Role
- Serializable
- Product
- Equals
- BaseRole
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Role(dbName: String, creationStatementsJson: JsonObject, revocationStatementsJson: JsonObject, defaultTtl: Duration, maxTtl: Duration)
- dbName
the name of the database connection to use for this role.
- creationStatementsJson
Specifies the database statements executed to create and configure a user. The object can optionally contain a "db" string for session connection, and must contain a "roles" array. This array contains objects that holds a "role", and an optional "db" value, and is similar to the BSON document that is accepted by MongoDB's roles field. Vault will transform this array into such format. For more information regarding the roles field, refer to MongoDB's documentation.
- revocationStatementsJson
Specifies the database statements to be executed to revoke a user. The object can optionally contain a "db" string. If no "db" value is provided, it defaults to the "admin" database.
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (Role, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val creationStatements: List[String]
The database statements executed to create and configure a user.
- val creationStatementsJson: JsonObject
- val dbName: String
The name of the database connection to use for this role.
- val defaultTtl: Duration
The TTL for the leases associated with this role.
- def ensuring(cond: (Role) => Boolean, msg: => Any): Role
- def ensuring(cond: (Role) => Boolean): Role
- def ensuring(cond: Boolean, msg: => Any): Role
- def ensuring(cond: Boolean): Role
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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 productElementNames: Iterator[String]
- Definition Classes
- Product
- val revocationStatements: List[String]
- val revocationStatementsJson: JsonObject
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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.