java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kms.model.KmsRequest
    - - software.amazon.awssdk.services.kms.model.ImportKeyMaterialRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ImportKeyMaterialRequest.Builder,ImportKeyMaterialRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ImportKeyMaterialRequest
extends KmsRequest
implements ToCopyableBuilder<ImportKeyMaterialRequest.Builder,ImportKeyMaterialRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ImportKeyMaterialRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ImportKeyMaterialRequest.Builder`	`builder()`
`SdkBytes`	`encryptedKeyMaterial()`	The encrypted key material to import.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExpirationModelType`	`expirationModel()`	Specifies whether the key material expires.
`String`	`expirationModelAsString()`	Specifies whether the key material expires.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`SdkBytes`	`importToken()`	The import token that you received in the response to a previous GetParametersForImport request.
`String`	`keyId()`	The identifier of the KMS key that will be associated with the imported key material.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ImportKeyMaterialRequest.Builder>`	`serializableBuilderClass()`
`ImportKeyMaterialRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`validTo()`	The date and time when the imported key material expires.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - keyId
```
public final String 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. 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.
    Returns:
    
    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.
  - importToken
```
public final 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.
    
    Returns:
    
    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.
  - encryptedKeyMaterial
```
public final SdkBytes 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.
    
    Returns:
    
    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.
  - validTo
```
public final Instant validTo()
```
    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:
    
    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.
  - expirationModel
```
public final ExpirationModelType 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 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.
    
    If the service returns an enum value that is not available in the current SDK version, expirationModel will return ExpirationModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expirationModelAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ExpirationModelType
  - expirationModelAsString
```
public final String expirationModelAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, expirationModel will return ExpirationModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expirationModelAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ExpirationModelType
  - toBuilder
```
public ImportKeyMaterialRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImportKeyMaterialRequest.Builder,ImportKeyMaterialRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
  - builder
```
public static ImportKeyMaterialRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImportKeyMaterialRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ImportKeyMaterialRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

keyId

importToken

encryptedKeyMaterial

validTo

expirationModel

expirationModelAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField