class SymbolicKms extends Kms
- Alphabetic
- By Inheritance
- SymbolicKms
- Kms
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SymbolicKms(crypto: Crypto, releaseProtocolVersion: ReleaseProtocolVersion)
Type Members
- type CreateKeySpec = SymbolicKmsCreateKeySpec
- Definition Classes
- SymbolicKms → Kms
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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def createKey(createKeySpec: Option[SymbolicKmsCreateKeySpec])(implicit ec: ExecutionContext): EitherT[Future, KmsError, KmsKeyId]
Creates a new key for the KMS.
Creates a new key for the KMS.
- createKeySpec
defines an optional create key specification (e.g. for aws we can a select a new key to be multi-region). If we use None we use the default specification (e.g. for aws multiRegion = false).
- returns
a key id or an error if it fails to create a key
- Definition Classes
- SymbolicKms → Kms
- def decryptData(keyId: KmsKeyId, data: ByteString)(implicit ec: ExecutionContext): EitherT[Future, KmsError, ByteString]
Decrypt the data passed as a byte array.
Decrypt the data passed as a byte array.
- keyId
key identifier (e.g. AWS key ARN)
- data
byte array to decrypt
- returns
a decrypted byte array or an error if it fails to decrypt
- Definition Classes
- SymbolicKms → Kms
- def deleteKey(keyId: KmsKeyId)(implicit ec: ExecutionContext): EitherT[Future, KmsError, Unit]
Schedule a deletion of a kms key (takes between 7-30 days)
Schedule a deletion of a kms key (takes between 7-30 days)
- keyId
key identifier (e.g. AWS key ARN)
- returns
an error if it fails to schedule a deletion of a key
- Definition Classes
- SymbolicKms → Kms
- def encryptData(keyId: KmsKeyId, data: ByteString)(implicit ec: ExecutionContext): EitherT[Future, KmsError, ByteString]
Encrypt the data passed as a byte array using a KMS key.
Encrypt the data passed as a byte array using a KMS key.
- keyId
key identifier (e.g. AWS key ARN)
- data
byte array to encrypt
- returns
an encrypted byte array or an error if it fails to encrypt
- Definition Classes
- SymbolicKms → Kms
- def ensureKeyExists(keyId: KmsKeyId)(implicit ec: ExecutionContext): EitherT[Future, KmsError, Unit]
Checks that a key identified by keyId exists in the KMS and therefore can be used.
Checks that a key identified by keyId exists in the KMS and therefore can be used.
- keyId
key identifier (e.g. AWS key ARN)
- returns
error if it fails to find key
- Definition Classes
- SymbolicKms → Kms
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listAllKeys()(implicit ec: ExecutionContext): EitherT[Future, KmsError, Seq[KmsKeyId]]
List all keys (represented by keyIds, keyARNs and keyAliases) in the kms/region that was configured
List all keys (represented by keyIds, keyARNs and keyAliases) in the kms/region that was configured
- returns
a sequence of different key identifiers or an error if it fails to list the kms keys
- Definition Classes
- SymbolicKms → Kms
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])