public class ImportKeyMaterialRequest extends AmazonWebServiceRequest implements java.io.Serializable
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the CMK to import the key material into. This
CMK's Origin
must be EXTERNAL
. You must also send
an import token and the encrypted key material. Send the import token that
you received in the same GetParametersForImport response that
contained the public key that you used to encrypt the key material. You must
also specify whether the key material expires and if so, when. When the key
material expires, AWS KMS deletes the key material and the CMK becomes
unusable. To use the CMK again, you can reimport the same key material. If
you set an expiration date, you can change it only by reimporting the same
key material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes to
Enabled
, and you can use the CMK.
After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
Constructor and Description |
---|
ImportKeyMaterialRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.nio.ByteBuffer |
getEncryptedKeyMaterial()
The encrypted key material to import.
|
java.lang.String |
getExpirationModel()
Specifies whether the key material expires.
|
java.nio.ByteBuffer |
getImportToken()
The import token that you received in the response to a previous
GetParametersForImport request.
|
java.lang.String |
getKeyId()
The identifier of the CMK to import the key material into.
|
java.util.Date |
getValidTo()
The time at which the imported key material expires.
|
int |
hashCode() |
void |
setEncryptedKeyMaterial(java.nio.ByteBuffer encryptedKeyMaterial)
The encrypted key material to import.
|
void |
setExpirationModel(ExpirationModelType expirationModel)
Specifies whether the key material expires.
|
void |
setExpirationModel(java.lang.String expirationModel)
Specifies whether the key material expires.
|
void |
setImportToken(java.nio.ByteBuffer importToken)
The import token that you received in the response to a previous
GetParametersForImport request.
|
void |
setKeyId(java.lang.String keyId)
The identifier of the CMK to import the key material into.
|
void |
setValidTo(java.util.Date validTo)
The time at which the imported key material expires.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ImportKeyMaterialRequest |
withEncryptedKeyMaterial(java.nio.ByteBuffer encryptedKeyMaterial)
The encrypted key material to import.
|
ImportKeyMaterialRequest |
withExpirationModel(ExpirationModelType expirationModel)
Specifies whether the key material expires.
|
ImportKeyMaterialRequest |
withExpirationModel(java.lang.String expirationModel)
Specifies whether the key material expires.
|
ImportKeyMaterialRequest |
withImportToken(java.nio.ByteBuffer importToken)
The import token that you received in the response to a previous
GetParametersForImport request.
|
ImportKeyMaterialRequest |
withKeyId(java.lang.String keyId)
The identifier of the CMK to import the key material into.
|
ImportKeyMaterialRequest |
withValidTo(java.util.Date validTo)
The time at which the imported key material expires.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getKeyId()
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
Constraints:
Length: 1 - 256
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
public void setKeyId(java.lang.String keyId)
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
Constraints:
Length: 1 - 256
keyId
-
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
public ImportKeyMaterialRequest withKeyId(java.lang.String keyId)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
keyId
-
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
public java.nio.ByteBuffer getImportToken()
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.
Constraints:
Length: 1 - 6144
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.
public void setImportToken(java.nio.ByteBuffer importToken)
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.
Constraints:
Length: 1 - 6144
importToken
- 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.
public ImportKeyMaterialRequest withImportToken(java.nio.ByteBuffer importToken)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 6144
importToken
- 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.
public java.nio.ByteBuffer getEncryptedKeyMaterial()
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.
Constraints:
Length: 1 - 6144
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.
public void setEncryptedKeyMaterial(java.nio.ByteBuffer encryptedKeyMaterial)
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.
Constraints:
Length: 1 - 6144
encryptedKeyMaterial
- 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.
public ImportKeyMaterialRequest withEncryptedKeyMaterial(java.nio.ByteBuffer encryptedKeyMaterial)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 6144
encryptedKeyMaterial
- 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.
public java.util.Date getValidTo()
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.
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.
public void setValidTo(java.util.Date validTo)
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.
validTo
-
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.
public ImportKeyMaterialRequest withValidTo(java.util.Date validTo)
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 a reference to this object so that method calls can be chained together.
validTo
-
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.
public java.lang.String getExpirationModel()
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.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
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.
ExpirationModelType
public void setExpirationModel(java.lang.String expirationModel)
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.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
expirationModel
-
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.
ExpirationModelType
public ImportKeyMaterialRequest withExpirationModel(java.lang.String expirationModel)
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 a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
expirationModel
-
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.
ExpirationModelType
public void setExpirationModel(ExpirationModelType expirationModel)
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.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
expirationModel
-
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.
ExpirationModelType
public ImportKeyMaterialRequest withExpirationModel(ExpirationModelType expirationModel)
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 a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
expirationModel
-
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.
ExpirationModelType
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.