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

Interface GetPublicKeyResponse.Builder

    • Method Detail

      • keyId

        GetPublicKeyResponse.Builder keyId​(String keyId)

        The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.

        Parameters:
        keyId - The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publicKey

        GetPublicKeyResponse.Builder publicKey​(SdkBytes publicKey)

        The exported public key.

        The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

        Parameters:
        publicKey - The exported public key.

        The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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

      • customerMasterKeySpec

        @Deprecated
GetPublicKeyResponse.Builder customerMasterKeySpec​(String customerMasterKeySpec)
        Deprecated.
        This field has been deprecated. Instead, use the KeySpec field.

        Instead, use the KeySpec field in the GetPublicKey response.

        The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

        Parameters:
        customerMasterKeySpec - Instead, use the KeySpec field in the GetPublicKey response.

        The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

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

      • customerMasterKeySpec

        @Deprecated
GetPublicKeyResponse.Builder customerMasterKeySpec​(CustomerMasterKeySpec customerMasterKeySpec)
        Deprecated.
        This field has been deprecated. Instead, use the KeySpec field.

        Instead, use the KeySpec field in the GetPublicKey response.

        The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

        Parameters:
        customerMasterKeySpec - Instead, use the KeySpec field in the GetPublicKey response.

        The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

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

      • keySpec

        GetPublicKeyResponse.Builder keySpec​(String keySpec)

        The type of the of the public key that was downloaded.

        Parameters:
        keySpec - The type of the of the public key that was downloaded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeySpec, KeySpec

      • keySpec

        GetPublicKeyResponse.Builder keySpec​(KeySpec keySpec)

        The type of the of the public key that was downloaded.

        Parameters:
        keySpec - The type of the of the public key that was downloaded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeySpec, KeySpec

      • keyUsage

        GetPublicKeyResponse.Builder keyUsage​(String keyUsage)

        The permitted use of the public key. Valid values for asymmetric key pairs are ENCRYPT_DECRYPT, SIGN_VERIFY, and KEY_AGREEMENT.

        This information is critical. For example, if a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

        Parameters:
        keyUsage - The permitted use of the public key. Valid values for asymmetric key pairs are ENCRYPT_DECRYPT, SIGN_VERIFY, and KEY_AGREEMENT.

        This information is critical. For example, if a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

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

      • keyUsage

        GetPublicKeyResponse.Builder keyUsage​(KeyUsageType keyUsage)

        The permitted use of the public key. Valid values for asymmetric key pairs are ENCRYPT_DECRYPT, SIGN_VERIFY, and KEY_AGREEMENT.

        This information is critical. For example, if a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

        Parameters:
        keyUsage - The permitted use of the public key. Valid values for asymmetric key pairs are ENCRYPT_DECRYPT, SIGN_VERIFY, and KEY_AGREEMENT.

        This information is critical. For example, if a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

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

      • encryptionAlgorithmsWithStrings

        GetPublicKeyResponse.Builder encryptionAlgorithmsWithStrings​(Collection<String> encryptionAlgorithms)

        The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

        Parameters:
        encryptionAlgorithms - The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

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

      • encryptionAlgorithmsWithStrings

        GetPublicKeyResponse.Builder encryptionAlgorithmsWithStrings​(String... encryptionAlgorithms)

        The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

        Parameters:
        encryptionAlgorithms - The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

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

      • encryptionAlgorithms

        GetPublicKeyResponse.Builder encryptionAlgorithms​(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms)

        The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

        Parameters:
        encryptionAlgorithms - The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

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

      • encryptionAlgorithms

        GetPublicKeyResponse.Builder encryptionAlgorithms​(EncryptionAlgorithmSpec... encryptionAlgorithms)

        The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

        Parameters:
        encryptionAlgorithms - The encryption algorithms that KMS supports for this key.

        This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

        This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

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

      • signingAlgorithmsWithStrings

        GetPublicKeyResponse.Builder signingAlgorithmsWithStrings​(Collection<String> signingAlgorithms)

        The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

        Parameters:
        signingAlgorithms - The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

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

      • signingAlgorithmsWithStrings

        GetPublicKeyResponse.Builder signingAlgorithmsWithStrings​(String... signingAlgorithms)

        The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

        Parameters:
        signingAlgorithms - The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

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

      • signingAlgorithms

        GetPublicKeyResponse.Builder signingAlgorithms​(Collection<SigningAlgorithmSpec> signingAlgorithms)

        The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

        Parameters:
        signingAlgorithms - The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

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

      • signingAlgorithms

        GetPublicKeyResponse.Builder signingAlgorithms​(SigningAlgorithmSpec... signingAlgorithms)

        The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

        Parameters:
        signingAlgorithms - The signing algorithms that KMS supports for this key.

        This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

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

      • keyAgreementAlgorithmsWithStrings

        GetPublicKeyResponse.Builder keyAgreementAlgorithmsWithStrings​(Collection<String> keyAgreementAlgorithms)

        The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.

        Parameters:
        keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyAgreementAlgorithmsWithStrings

        GetPublicKeyResponse.Builder keyAgreementAlgorithmsWithStrings​(String... keyAgreementAlgorithms)

        The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.

        Parameters:
        keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyAgreementAlgorithms

        GetPublicKeyResponse.Builder keyAgreementAlgorithms​(Collection<KeyAgreementAlgorithmSpec> keyAgreementAlgorithms)

        The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.

        Parameters:
        keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyAgreementAlgorithms

        GetPublicKeyResponse.Builder keyAgreementAlgorithms​(KeyAgreementAlgorithmSpec... keyAgreementAlgorithms)

        The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.

        Parameters:
        keyAgreementAlgorithms - The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.