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

Interface DecryptRequest.Builder

    • Method Detail

      • ciphertextBlob

        DecryptRequest.Builder ciphertextBlob​(SdkBytes ciphertextBlob)

        Ciphertext to be decrypted. The blob includes metadata.

        Parameters:
        ciphertextBlob - Ciphertext to be decrypted. The blob includes metadata.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encryptionContext

        DecryptRequest.Builder encryptionContext​(Map<String,​String> encryptionContext)

        Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

        An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

        For more information, see Encryption context in the Key Management Service Developer Guide.

        Parameters:
        encryptionContext - Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

        An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

        For more information, see Encryption context in the Key Management Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • grantTokens

        DecryptRequest.Builder grantTokens​(Collection<String> grantTokens)

        A list of grant tokens.

        Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

        Parameters:
        grantTokens - A list of grant tokens.

        Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • grantTokens

        DecryptRequest.Builder grantTokens​(String... grantTokens)

        A list of grant tokens.

        Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

        Parameters:
        grantTokens - A list of grant tokens.

        Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyId

        DecryptRequest.Builder keyId​(String keyId)

        Specifies the KMS key that KMS uses to decrypt the ciphertext.

        Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

        This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

        To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

        For example:

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

        • Alias name: alias/ExampleAlias

        • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

        To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

        Parameters:
        keyId - Specifies the KMS key that KMS uses to decrypt the ciphertext.

        Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

        This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

        To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

        For example:

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

        • Alias name: alias/ExampleAlias

        • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

        To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encryptionAlgorithm

        DecryptRequest.Builder encryptionAlgorithm​(String encryptionAlgorithm)

        Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

        This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

        Parameters:
        encryptionAlgorithm - Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

        This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncryptionAlgorithmSpec, EncryptionAlgorithmSpec

      • encryptionAlgorithm

        DecryptRequest.Builder encryptionAlgorithm​(EncryptionAlgorithmSpec encryptionAlgorithm)

        Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

        This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

        Parameters:
        encryptionAlgorithm - Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

        This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncryptionAlgorithmSpec, EncryptionAlgorithmSpec

      • recipient

        DecryptRequest.Builder recipient​(RecipientInfo recipient)

        A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

        This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

        When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

        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.

        Parameters:
        recipient - A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

        This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

        When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recipient

        default DecryptRequest.Builder recipient​(Consumer<RecipientInfo.Builder> recipient)

        A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

        This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

        When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

        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.

        This is a convenience method that creates an instance of the RecipientInfo.Builder avoiding the need to create one manually via RecipientInfo.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recipient(RecipientInfo).

        Parameters:
        recipient - a consumer that will call methods on RecipientInfo.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        recipient(RecipientInfo)

      • dryRun

        DecryptRequest.Builder dryRun​(Boolean dryRun)

        Checks if your request will succeed. DryRun is an optional parameter.

        To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

        Parameters:
        dryRun - Checks if your request will succeed. DryRun is an optional parameter.

        To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.