You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::KMS::Types::ImportKeyMaterialRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::ImportKeyMaterialRequest
- Defined in:
- (unknown)
Overview
When passing ImportKeyMaterialRequest as input to an Aws::Client method, you can use a vanilla 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 symmetric CMK that receives the imported key material.
-
#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. The key material must be encrypted
with the public wrapping key that GetParametersForImport
returned, using the wrapping algorithm that you specified in the same
GetParametersForImport
request.
#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.
Possible values:
- KEY_MATERIAL_EXPIRES
- KEY_MATERIAL_DOES_NOT_EXPIRE
#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.
#key_id ⇒ String
The identifier of the symmetric CMK that receives the imported key
material. The CMK\'s Origin
must be EXTERNAL
. This must be the same
CMK specified in the KeyID
parameter of the corresponding
GetParametersForImport request.
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.
#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.