software.amazon.awssdk.services.kms.model

Interface ImportKeyMaterialRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ImportKeyMaterialRequest.Builder,ImportKeyMaterialRequest>, KmsRequest.Builder, SdkBuilder<ImportKeyMaterialRequest.Builder,ImportKeyMaterialRequest>, SdkRequest.Builder

Enclosing class:

ImportKeyMaterialRequest

public static interface ImportKeyMaterialRequest.Builder
extends KmsRequest.Builder, CopyableBuilder<ImportKeyMaterialRequest.Builder,ImportKeyMaterialRequest>

Method Summary

Modifier and Type	Method and Description
ImportKeyMaterialRequest.Builder	encryptedKeyMaterial(SdkBytes encryptedKeyMaterial) The encrypted key material to import.
ImportKeyMaterialRequest.Builder	expirationModel(ExpirationModelType expirationModel) Specifies whether the key material expires.
ImportKeyMaterialRequest.Builder	expirationModel(String expirationModel) Specifies whether the key material expires.
ImportKeyMaterialRequest.Builder	importToken(SdkBytes importToken) The import token that you received in the response to a previous GetParametersForImport request.
ImportKeyMaterialRequest.Builder	keyId(String keyId) The identifier of the CMK to import the key material into.
ImportKeyMaterialRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ImportKeyMaterialRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ImportKeyMaterialRequest.Builder	validTo(Instant validTo) The time at which the imported key material expires.

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder

build

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.utils.builder.SdkBuilder

applyMutation, build

Method Detail

keyId

ImportKeyMaterialRequest.Builder keyId(String keyId)

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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

Parameters:

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

importToken

ImportKeyMaterialRequest.Builder importToken(SdkBytes 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

ImportKeyMaterialRequest.Builder encryptedKeyMaterial(SdkBytes 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

validTo

ImportKeyMaterialRequest.Builder validTo(Instant 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

expirationModel

ImportKeyMaterialRequest.Builder expirationModel(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExpirationModelType, ExpirationModelType

expirationModel

ImportKeyMaterialRequest.Builder expirationModel(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExpirationModelType, ExpirationModelType

overrideConfiguration

ImportKeyMaterialRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.