software.amazon.awssdk.services.kms.model

Class GetParametersForImportRequest

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.GetParametersForImportRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetParametersForImportRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetParametersForImportRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId() The identifier of the symmetric encryption KMS key into which you will import key material.
List<SdkField<?>>	sdkFields()
static Class<? extends GetParametersForImportRequest.Builder>	serializableBuilderClass()
GetParametersForImportRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AlgorithmSpec	wrappingAlgorithm() The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
String	wrappingAlgorithmAsString() The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
WrappingKeySpec	wrappingKeySpec() The type of wrapping key (public key) to return in the response.
String	wrappingKeySpecAsString() The type of wrapping key (public key) to return in the response.

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 symmetric encryption KMS key into which you will import key material. The Origin of the KMS key must be EXTERNAL.

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 symmetric encryption KMS key into which you will import key material. The Origin of the KMS key must be EXTERNAL.

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.

wrappingAlgorithm

public final AlgorithmSpec wrappingAlgorithm()

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.

If the service returns an enum value that is not available in the current SDK version, wrappingAlgorithm will return AlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingAlgorithmAsString().

Returns:

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.

See Also:

AlgorithmSpec

wrappingAlgorithmAsString

public final String wrappingAlgorithmAsString()

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.

If the service returns an enum value that is not available in the current SDK version, wrappingAlgorithm will return AlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingAlgorithmAsString().

Returns:

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.

See Also:

AlgorithmSpec

wrappingKeySpec

public final WrappingKeySpec wrappingKeySpec()

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

If the service returns an enum value that is not available in the current SDK version, wrappingKeySpec will return WrappingKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingKeySpecAsString().

Returns:

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

See Also:

WrappingKeySpec

wrappingKeySpecAsString

public final String wrappingKeySpecAsString()

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

If the service returns an enum value that is not available in the current SDK version, wrappingKeySpec will return WrappingKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingKeySpecAsString().

Returns:

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

See Also:

WrappingKeySpec

toBuilder

public GetParametersForImportRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static GetParametersForImportRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetParametersForImportRequest.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