Class: Aws::KMS::Types::GenerateDataKeyResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:plaintext]

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_blob ⇒ String

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.

Returns:

  • (String) 


2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-kms/types.rb', line 2951

class GenerateDataKeyResponse < Struct.new(
  :ciphertext_blob,
  :plaintext,
  :key_id,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#ciphertext_for_recipient ⇒ String

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][1

in the *Key

Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html

Returns:

  • (String) 


2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-kms/types.rb', line 2951

class GenerateDataKeyResponse < Struct.new(
  :ciphertext_blob,
  :plaintext,
  :key_id,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#key_id ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN

Returns:

  • (String) 


2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-kms/types.rb', line 2951

class GenerateDataKeyResponse < Struct.new(
  :ciphertext_blob,
  :plaintext,
  :key_id,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#plaintext ⇒ String

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.

Returns:

  • (String) 


2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-kms/types.rb', line 2951

class GenerateDataKeyResponse < Struct.new(
  :ciphertext_blob,
  :plaintext,
  :key_id,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end