Class: Aws::KMS::Types::ImportKeyMaterialRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::ImportKeyMaterialRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
When making an API call, you may pass ImportKeyMaterialRequest data as a hash:
{
key_id: "KeyIdType", # required
import_token: "data", # required
encrypted_key_material: "data", # required
valid_to: Time.now,
expiration_model: "KEY_MATERIAL_EXPIRES", # accepts KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
}
Instance Attribute Summary collapse
-
#encrypted_key_material ⇒ String
The encrypted key material to import.
-
#expiration_model ⇒ String
Specifies whether the key material expires.
-
#import_token ⇒ String
The import token that you received in the response to a previous GetParametersForImport request.
-
#key_id ⇒ String
The identifier of the CMK to import the key material into.
-
#valid_to ⇒ Time
The time at which the imported key material expires.
Instance Attribute Details
#encrypted_key_material ⇒ String
The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request.
1388 1389 1390 1391 1392 1393 1394 1395 |
# File 'lib/aws-sdk-kms/types.rb', line 1388 class ImportKeyMaterialRequest < Struct.new( :key_id, :import_token, :encrypted_key_material, :valid_to, :expiration_model) include Aws::Structure end |
#expiration_model ⇒ String
Specifies whether the key material expires. The default is ‘KEY_MATERIAL_EXPIRES`, in which case you must include the `ValidTo` parameter. When this parameter is set to `KEY_MATERIAL_DOES_NOT_EXPIRE`, you must omit the `ValidTo` parameter.
1388 1389 1390 1391 1392 1393 1394 1395 |
# File 'lib/aws-sdk-kms/types.rb', line 1388 class ImportKeyMaterialRequest < Struct.new( :key_id, :import_token, :encrypted_key_material, :valid_to, :expiration_model) include Aws::Structure end |
#import_token ⇒ String
The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.
1388 1389 1390 1391 1392 1393 1394 1395 |
# File 'lib/aws-sdk-kms/types.rb', line 1388 class ImportKeyMaterialRequest < Struct.new( :key_id, :import_token, :encrypted_key_material, :valid_to, :expiration_model) include Aws::Structure end |
#key_id ⇒ String
The identifier of the CMK to import the key material into. The CMK’s ‘Origin` must be `EXTERNAL`.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`
-
Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
1388 1389 1390 1391 1392 1393 1394 1395 |
# File 'lib/aws-sdk-kms/types.rb', line 1388 class ImportKeyMaterialRequest < Struct.new( :key_id, :import_token, :encrypted_key_material, :valid_to, :expiration_model) include Aws::Structure end |
#valid_to ⇒ Time
The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ‘ExpirationModel` parameter is set to `KEY_MATERIAL_DOES_NOT_EXPIRE`. Otherwise it is required.
1388 1389 1390 1391 1392 1393 1394 1395 |
# File 'lib/aws-sdk-kms/types.rb', line 1388 class ImportKeyMaterialRequest < Struct.new( :key_id, :import_token, :encrypted_key_material, :valid_to, :expiration_model) include Aws::Structure end |