You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KMS::Types::ImportKeyMaterialRequest

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

Overview

Note:

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

Instance Attribute Details

#encrypted_key_materialString

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.

Returns:

  • (String)


1298
1299
1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1298

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  include Aws::Structure
end

#expiration_modelString

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.

Returns:

  • (String)


1298
1299
1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1298

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  include Aws::Structure
end

#import_tokenString

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.

Returns:

  • (String)


1298
1299
1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1298

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  include Aws::Structure
end

#key_idString

The identifier of the CMK to import the key material into. The CMK's Origin must be EXTERNAL.

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

  • (String)


1298
1299
1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1298

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  include Aws::Structure
end

#valid_toTime

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.

Returns:

  • (Time)


1298
1299
1300
1301
1302
1303
1304
1305
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1298

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  include Aws::Structure
end