Class: Aws::KMS::Types::GenerateDataKeyRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

Checks if your request will succeed. ‘DryRun` is an optional parameter.

To learn more about how to use this parameter, see [Testing your KMS API calls] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html

Returns:

  • (Boolean) 


2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_context ⇒ Hash<String,String>

Specifies the encryption context that will be used when encrypting the data key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

An *encryption context* is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see [Encryption context] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context

Returns:

  • (Hash<String,String>) 


2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#grant_tokens ⇒ Array<String>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved *eventual consistency*. For more information, see [Grant token] and [Using a grant token] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token

Returns:

  • (Array<String>) 


2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ String

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with ‘“alias/”`. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

  • (String) 


2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#key_spec ⇒ String

Specifies the length of the data key. Use ‘AES_128` to generate a 128-bit symmetric key, or `AES_256` to generate a 256-bit symmetric key.

You must specify either the ‘KeySpec` or the `NumberOfBytes` parameter (but not both) in every `GenerateDataKey` request.

Returns:

  • (String) 


2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_bytes ⇒ Integer

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the ‘KeySpec` parameter.

You must specify either the ‘KeySpec` or the `NumberOfBytes` parameter (but not both) in every `GenerateDataKey` request.

Returns:

  • (Integer) 


2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#recipient ⇒ Types::RecipientInfo

A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave’s public key. The only valid encryption algorithm is ‘RSAES_OAEP_SHA_256`.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the [Amazon Web Services Nitro Enclaves SDK] or any Amazon Web Services SDK.

When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the ‘CiphertextForRecipient` field in the response. This ciphertext can be decrypted only with the private key in the enclave. The `CiphertextBlob` field in the response contains a copy of the data key encrypted under the KMS key specified by the `KeyId` parameter. The `Plaintext` field in the response is null or empty.

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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc [2]: docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk [3]: docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html

Returns:



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/aws-sdk-kms/types.rb', line 2889

class GenerateDataKeyRequest < Struct.new(
  :key_id,
  :encryption_context,
  :number_of_bytes,
  :key_spec,
  :grant_tokens,
  :recipient,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end