Package software.amazon.awssdk.services.kms.model

Class RecipientInfo

java.lang.Object

software.amazon.awssdk.services.kms.model.RecipientInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecipientInfo.Builder,RecipientInfo>

@Generated("software.amazon.awssdk:codegen")
public final class RecipientInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecipientInfo.Builder,RecipientInfo>

Contains information about the party that receives the response from the API operation.

This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated compute environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecipientInfo.Builder

Method Summary

Modifier and Type	Method	Description
SdkBytes	attestationDocument()	The attestation document for an Amazon Web Services Nitro Enclave.
static RecipientInfo.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KeyEncryptionMechanism	keyEncryptionAlgorithm()	The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response.
String	keyEncryptionAlgorithmAsString()	The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RecipientInfo.Builder>	serializableBuilderClass()
RecipientInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

keyEncryptionAlgorithm

public final KeyEncryptionMechanism keyEncryptionAlgorithm()

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

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

Returns:

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

See Also:

KeyEncryptionMechanism

keyEncryptionAlgorithmAsString

public final String keyEncryptionAlgorithmAsString()

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

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

Returns:

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

See Also:

KeyEncryptionMechanism

attestationDocument

public final SdkBytes attestationDocument()

The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

Returns:

The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

toBuilder

public RecipientInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecipientInfo.Builder,RecipientInfo>

builder

public static RecipientInfo.Builder builder()

serializableBuilderClass

public static Class<? extends RecipientInfo.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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