Skip to main content

IKMSEncryptRequest

Interface in AWS.KMS

Interface for Encrypt requests.

Ancestors

Properties

EncryptionAlgorithm

property EncryptionAlgorithm: string

Specify the encryption algorithm that will be used to encrypt the plaintext message.

Only required when the ciphertext was encrypted with an asymmetric KMS key. The default value SYMMETRIC_DEFAULT is the only valid value for symmetric encryption KMS keys. Valid values: SYMMETRIC_DEFAULT | RSAES_OAEP_SHA_1 | RSAES_OAEP_SHA_256 | SM2PKE.

EncryptionContext

property EncryptionContext: TDictionary<string, string>

Specify the encryption context to use when encrypting the data.

GrantTokens

property GrantTokens: TList<string>

Specify a list of grant tokens.

KeyId

property KeyId: string

Specify the Amazon Resource Name (ARN), ID, alias name, or aliad ARN of a KMS key to use to encrypt the ciphertext.

Plaintext

property Plaintext: TStream

The data to be encrypted.

Methods

AddEncryptionContext

procedure AddEncryptionContext(const AKey, AValue: string);

Add a key/value to EncryptionContext.

Parameters

NameDescription
AKeySpecify the context key.
AValueSpecify the context value.

AddGrantToken

function AddGrantToken(const AGrantToken: string): Integer;

Add a token to GrantTokens.

Parameters

NameDescription
AGrantTokenSpecify the grant token to add to GrantTokens.

Returns

Returns the index of the item added to GrantTokens.