Package software.amazon.awssdk.services.paymentcryptography.model

Class ImportKeyRequest

    • Method Detail

      • enabled

        public final Boolean enabled()

        Specifies whether import key is enabled.

        Returns:
        Specifies whether import key is enabled.

      • keyCheckValueAlgorithm

        public final KeyCheckValueAlgorithm keyCheckValueAlgorithm()

        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

        For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

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

        Returns:
        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

        For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

        See Also:
        KeyCheckValueAlgorithm

      • keyCheckValueAlgorithmAsString

        public final String keyCheckValueAlgorithmAsString()

        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

        For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

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

        Returns:
        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

        For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

        See Also:
        KeyCheckValueAlgorithm

      • keyMaterial

        public final ImportKeyMaterial keyMaterial()

        The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

        Returns:
        The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

        To use this parameter, you must have TagResource permission.

        Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

        You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

        To use this parameter, you must have TagResource permission.

        Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

      • 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