Class: Aws::KMS::Types::GenerateDataKeyPairRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::GenerateDataKeyPairRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #encryption_context ⇒ Hash<String,String>

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

• #grant_tokens ⇒ Array<String>

  A list of grant tokens.

• #key_id ⇒ String

  Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair.

• #key_pair_spec ⇒ String

  Determines the type of data key pair that is generated.

• #recipient ⇒ Types::RecipientInfo

  A signed [attestation document] from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document.

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 permissions] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-kms/types.rb', line 2650

class GenerateDataKeyPairRequest < Struct.new(
  :encryption_context,
  :key_id,
  :key_pair_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 private key in the data key pair.

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/encrypt_context.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-kms/types.rb', line 2650

class GenerateDataKeyPairRequest < Struct.new(
  :encryption_context,
  :key_id,
  :key_pair_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/using-grant-token.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kms/types.rb', line 2650

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

#key_id ⇒ String

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. 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)

# File 'lib/aws-sdk-kms/types.rb', line 2650

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

#key_pair_spec ⇒ String

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), the rule that permits you to use ECC KMS keys only to sign and verify, and the rule that permits you to use ML-DSA key pairs to sign and verify only are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 2650

class GenerateDataKeyPairRequest < Struct.new(
  :encryption_context,
  :key_id,
  :key_pair_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 or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is ‘RSAES_OAEP_SHA_256`.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM. To call GenerateDataKeyPair generate an attestation document use either

Amazon Web Services Nitro Enclaves SDK][2

for an Amazon Web

Services Nitro Enclaves or [Amazon Web Services NitroTPM tools] for Amazon Web Services NitroTPM. Then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the attested environment.

When you use this parameter, instead of returning a plaintext copy of the private data key, KMS encrypts the plaintext private 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 attested environment. The `CiphertextBlob` field in the response contains a copy of the private data key encrypted under the KMS key specified by the `KeyId` parameter. The `PrivateKeyPlaintext` field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see

Cryptographic attestation support in KMS][4

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/AWSEC2/latest/UserGuide/attestation-get-doc.html [4]: docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html

Returns:

• (Types::RecipientInfo)

# File 'lib/aws-sdk-kms/types.rb', line 2650

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