AWSKMSGenerateDataKeyResponse

Objective-C

@interface AWSKMSGenerateDataKeyResponse

Swift

class AWSKMSGenerateDataKeyResponse

  • The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable ciphertextBlob;

    Swift

    var ciphertextBlob: Data? { get set }

  • The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable ciphertextForRecipient;

    Swift

    var ciphertextForRecipient: Data? { get set }

  • The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }

  • The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

    If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable plaintext;

    Swift

    var plaintext: Data? { get set }