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

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

Overview

Note:

When making an API call, you may pass GenerateDataKeyPairRequest data as a hash:

{
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  key_id: "KeyIdType", # required
  key_pair_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2
  grant_tokens: ["GrantTokenType"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_contextHash<String,String>

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

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>)

2007
2008
2009
2010
2011
2012
2013
2014
# File 'lib/aws-sdk-kms/types.rb', line 2007

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

#grant_tokensArray<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>)

2007
2008
2009
2010
2011
2012
2013
2014
# File 'lib/aws-sdk-kms/types.rb', line 2007

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

#key_idString

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)

2007
2008
2009
2010
2011
2012
2013
2014
# File 'lib/aws-sdk-kms/types.rb', line 2007

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

#key_pair_specString

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), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.

Returns:

  • (String)

2007
2008
2009
2010
2011
2012
2013
2014
# File 'lib/aws-sdk-kms/types.rb', line 2007

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