kms/aws.sdk.kotlin.services.kms.model/EncryptRequest

EncryptRequest

class EncryptRequest

Types

Builder

class Builder

Companion

object Companion

Properties

dryRun

val dryRun: Boolean?

Checks if your request will succeed. DryRun is an optional parameter.

encryptionAlgorithm

val encryptionAlgorithm: EncryptionAlgorithmSpec?

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

encryptionContext

val encryptionContext: Map<String, String>?

Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

grantTokens

val grantTokens: List<String>?

A list of grant tokens.

keyId

val keyId: String?

Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

plaintext

val plaintext: ByteArray?

Data to be encrypted.

Functions

copy

inline fun copy(block: EncryptRequest.Builder.() -> Unit = {}): EncryptRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String