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 and Amazon Web Services NitroTPM, which lets you create an attested environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

See Also:

  • Method Details

    • keyEncryptionAlgorithm

      public final KeyEncryptionMechanism keyEncryptionAlgorithm()

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave or NitroTPM 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 or NitroTPM to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
      See Also:

    • keyEncryptionAlgorithmAsString

      public final String keyEncryptionAlgorithmAsString()

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave or NitroTPM 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 or NitroTPM to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
      See Also:

    • attestationDocument

      public final SdkBytes attestationDocument()

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

      Returns:
      The attestation document for an Amazon Web Services Nitro Enclave or a NitroTPM. This document includes the enclave's public key.

    • toBuilder

      public RecipientInfo.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RecipientInfo.Builder,RecipientInfo>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.