AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

Constant Summary collapse

SENSITIVE =
[:plaintext]

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_blobString

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

Returns:

  • (String)


2075
2076
2077
2078
2079
2080
2081
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2075

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

#key_idString

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

Returns:

  • (String)


2075
2076
2077
2078
2079
2080
2081
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2075

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

#plaintextString

The plaintext data key. When you use the HTTP API or the AWS 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.

Returns:

  • (String)


2075
2076
2077
2078
2079
2080
2081
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2075

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