Class: Aws::KMS::Types::GenerateDataKeyWithoutPlaintextRequest

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 GenerateDataKeyWithoutPlaintextRequest data as a hash:

{
  key_id: "KeyIdType", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  key_spec: "AES_256", # accepts AES_256, AES_128
  number_of_bytes: 1,
  grant_tokens: ["GrantTokenType"],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_context ⇒ Hash<String,String>

A set of key-value pairs that represents additional authenticated data.

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html

Returns:

  • (Hash<String,String>) 


1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-kms/types.rb', line 1332

class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
  :key_id,
  :encryption_context,
  :key_spec,
  :number_of_bytes,
  :grant_tokens)
  include Aws::Structure
end

#grant_tokens ⇒ Array<String>

A list of grant tokens.

For more information, see [Grant Tokens] in the *AWS Key Management Service Developer Guide*.

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

Returns:

  • (Array<String>) 


1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-kms/types.rb', line 1332

class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
  :key_id,
  :encryption_context,
  :key_spec,
  :number_of_bytes,
  :grant_tokens)
  include Aws::Structure
end

#key_id ⇒ String

The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

  • (String) 


1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-kms/types.rb', line 1332

class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
  :key_id,
  :encryption_context,
  :key_spec,
  :number_of_bytes,
  :grant_tokens)
  include Aws::Structure
end

#key_spec ⇒ String

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

Returns:

  • (String) 


1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-kms/types.rb', line 1332

class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
  :key_id,
  :encryption_context,
  :key_spec,
  :number_of_bytes,
  :grant_tokens)
  include Aws::Structure
end

#number_of_bytes ⇒ Integer

The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the ‘KeySpec` field instead of this one.

Returns:

  • (Integer) 


1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-kms/types.rb', line 1332

class GenerateDataKeyWithoutPlaintextRequest < Struct.new(
  :key_id,
  :encryption_context,
  :key_spec,
  :number_of_bytes,
  :grant_tokens)
  include Aws::Structure
end