Interface ImportKeyMaterialRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ImportKeyMaterialRequest.Builder,
,ImportKeyMaterialRequest> KmsRequest.Builder
,SdkBuilder<ImportKeyMaterialRequest.Builder,
,ImportKeyMaterialRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ImportKeyMaterialRequest
-
Method Summary
Modifier and TypeMethodDescriptionencryptedKeyMaterial
(SdkBytes encryptedKeyMaterial) The encrypted key material to import.expirationModel
(String expirationModel) Specifies whether the key material expires.expirationModel
(ExpirationModelType expirationModel) Specifies whether the key material expires.importToken
(SdkBytes importToken) The import token that you received in the response to a previous GetParametersForImport request.The identifier of the KMS key that will be associated with the imported key material.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The date and time when the imported key material expires.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
keyId
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. TheOrigin
of the KMS key must beEXTERNAL
and itsKeyState
must bePendingImport
.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.
- Parameters:
keyId
- The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in theKeyID
parameter of the corresponding GetParametersForImport request. TheOrigin
of the KMS key must beEXTERNAL
and itsKeyState
must bePendingImport
.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
encryptedKeyMaterial
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.- Parameters:
encryptedKeyMaterial
- 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 sameGetParametersForImport
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validTo
The date and time when the imported key material expires. This parameter is required when the value of the
ExpirationModel
parameter isKEY_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
orValidTo
values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.- Parameters:
validTo
- The date and time when the imported key material expires. This parameter is required when the value of theExpirationModel
parameter isKEY_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
orValidTo
values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expirationModel
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
isKEY_MATERIAL_EXPIRES
, you must specify a value for theValidTo
parameter. When value isKEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit theValidTo
parameter.You cannot change the
ExpirationModel
orValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.- Parameters:
expirationModel
- Specifies whether the key material expires. The default isKEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.When the value of
ExpirationModel
isKEY_MATERIAL_EXPIRES
, you must specify a value for theValidTo
parameter. When value isKEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit theValidTo
parameter.You cannot change the
ExpirationModel
orValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
expirationModel
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
isKEY_MATERIAL_EXPIRES
, you must specify a value for theValidTo
parameter. When value isKEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit theValidTo
parameter.You cannot change the
ExpirationModel
orValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.- Parameters:
expirationModel
- Specifies whether the key material expires. The default isKEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.When the value of
ExpirationModel
isKEY_MATERIAL_EXPIRES
, you must specify a value for theValidTo
parameter. When value isKEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit theValidTo
parameter.You cannot change the
ExpirationModel
orValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ImportKeyMaterialRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ImportKeyMaterialRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-