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

Class GenerateDataKeyPairResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kms.model.KmsResponse
software.amazon.awssdk.services.kms.model.GenerateDataKeyPairResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GenerateDataKeyPairResponse.Builder,GenerateDataKeyPairResponse>
@Generated("software.amazon.awssdk:codegen") public final class GenerateDataKeyPairResponse extends KmsResponse implements ToCopyableBuilder<GenerateDataKeyPairResponse.Builder,GenerateDataKeyPairResponse>

  • Method Details

    • privateKeyCiphertextBlob

      public final SdkBytes privateKeyCiphertextBlob()

      The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      Returns:
      The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • privateKeyPlaintext

      public final SdkBytes privateKeyPlaintext()

      The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext field is null or empty.

      Returns:
      The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext field is null or empty.

    • publicKey

      public final SdkBytes publicKey()

      The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      Returns:
      The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • keyId

      public final String keyId()

      The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

      Returns:
      The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

    • keyPairSpec

      public final DataKeyPairSpec keyPairSpec()

      The type of data key pair that was generated.

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

      Returns:
      The type of data key pair that was generated.
      See Also:

    • keyPairSpecAsString

      public final String keyPairSpecAsString()

      The type of data key pair that was generated.

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

      Returns:
      The type of data key pair that was generated.
      See Also:

    • ciphertextForRecipient

      public final SdkBytes ciphertextForRecipient()

      The plaintext private data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. 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.

      Returns:
      The plaintext private data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. 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.

    • keyMaterialId

      public final String keyMaterialId()

      The identifier of the key material used to encrypt the private key.

      Returns:
      The identifier of the key material used to encrypt the private key.

    • toBuilder

      public GenerateDataKeyPairResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GenerateDataKeyPairResponse.Builder,GenerateDataKeyPairResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GenerateDataKeyPairResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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 SdkResponse

    • 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