AWSKMSGenerateDataKeyWithoutPlaintextRequest Class Reference

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

  encryptionContext

A set of key-value pairs that represents additional authenticated data.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

@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

The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.

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

  keySpec

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

@property (nonatomic, assign) AWSKMSDataKeySpec keySpec

Declared In

AWSKMSModel.h

  numberOfBytes

The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

@property (nonatomic, strong) NSNumber *numberOfBytes

Declared In

AWSKMSModel.h