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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encrypted_key_material ⇒ String

The encrypted key material to import. The key material must be encrypted under the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same ‘GetParametersForImport` request.

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

#expiration_model ⇒ String

Specifies whether the key material expires. The default is ‘KEY_MATERIAL_EXPIRES`. For help with this choice, see [Setting an expiration time] in the *Key Management Service Developer Guide*.

When the value of ‘ExpirationModel` is `KEY_MATERIAL_EXPIRES`, you must specify a value for the `ValidTo` parameter. When value is `KEY_MATERIAL_DOES_NOT_EXPIRE`, you must omit the `ValidTo` parameter.

You cannot change the ‘ExpirationModel` or `ValidTo` values for the current import after the request completes. To change either value, you must reimport the key material.

[1]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#importing-keys-expiration

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

#import_type ⇒ String

Indicates whether the key material being imported is previously associated with this KMS key or not. This parameter is optional and only usable with symmetric encryption keys. The default is ‘EXISTING_KEY_MATERIAL`. If no key material has ever been imported into the KMS key, and this parameter is omitted, the parameter defaults to `NEW_KEY_MATERIAL`.

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

#key_id ⇒ String

The identifier of the KMS key that will be associated with 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` and its `KeyState` must be `PendingImport`.

The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a [multi-Region key] of any supported type. You cannot perform this operation on 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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

#key_material_description ⇒ String

Description for the key material being imported. This parameter is optional and only usable with symmetric encryption keys. If you do not specify a key material description, KMS retains the value you specified when you last imported the same key material into this KMS key.

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

#key_material_id ⇒ String

Identifies the key material being imported. This parameter is optional and only usable with symmetric encryption keys. You cannot specify a key material ID with ‘ImportType` set to `NEW_KEY_MATERIAL`. Whenever you import key material into a symmetric encryption key, KMS assigns a unique identifier to the key material based on the KMS key ID and the imported key material. When you re-import key material with a specified key material ID, KMS:

  • Computes the identifier for the key material

  • Matches the computed identifier against the specified key material ID

  • Verifies that the key material ID is already associated with the KMS key

To get the list of key material IDs associated with a KMS key, use ListKeyRotations.

Returns:

  • (String) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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

#valid_to ⇒ Time

The date and time when the imported key material expires. This parameter is required when the value of the ‘ExpirationModel` parameter is `KEY_MATERIAL_EXPIRES`. Otherwise it is not valid.

The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.

When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.

You cannot change the ‘ExpirationModel` or `ValidTo` values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.

Returns:

  • (Time) 


3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/aws-sdk-kms/types.rb', line 3980

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