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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encrypted_key_materialString

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.

Returns:

  • (String)

3108
3109
3110
3111
3112
3113
3114
3115
3116
# File 'lib/aws-sdk-kms/types.rb', line 3108

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  SENSITIVE = []
  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)

3108
3109
3110
3111
3112
3113
3114
3115
3116
# File 'lib/aws-sdk-kms/types.rb', line 3108

class ImportKeyMaterialRequest < Struct.new(
  :key_id,
  :import_token,
  :encrypted_key_material,
  :valid_to,
  :expiration_model)
  SENSITIVE = []
  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)

3108
3109
3110
3111
3112
3113
3114
3115
3116
# File 'lib/aws-sdk-kms/types.rb', line 3108

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

#key_idString

The identifier of the symmetric encryption KMS key that receives the imported key material. This must be the same KMS key specified in the `KeyID` parameter of the corresponding GetParametersForImport request. The `Origin` of the KMS key must be `EXTERNAL`. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Returns:

  • (String)

3108
3109
3110
3111
3112
3113
3114
3115
3116
# File 'lib/aws-sdk-kms/types.rb', line 3108

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

#valid_toTime

The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key 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)

3108
3109
3110
3111
3112
3113
3114
3115
3116
# File 'lib/aws-sdk-kms/types.rb', line 3108

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