AWSKMSEncryptRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSKMSModel.h
AWSKMSModel.m

  encryptionContext

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *encryptionContext

Declared In

AWSKMSModel.h

  grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

@property (nonatomic, strong) NSArray<NSString*> *grantTokens

Declared In

AWSKMSModel.h

  keyId

A unique identifier for the customer master key (CMK).

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

@property (nonatomic, strong) NSString *keyId

Declared In

AWSKMSModel.h

  plaintext

Data to be encrypted.

@property (nonatomic, strong) NSData *plaintext

Declared In

AWSKMSModel.h