Class DukptEncryptionAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DukptEncryptionAttributes.Builder,
DukptEncryptionAttributes>
Parameters that are required to encrypt plaintext data using DUKPT.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DukptDerivationType
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).final String
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).final DukptKeyVariant
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.final String
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
An input used to provide the intial state.final String
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method.final DukptEncryptionMode
mode()
The block cipher method to use for encryption.final String
The block cipher method to use for encryption.static Class
<? extends DukptEncryptionAttributes.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
dukptKeyDerivationType
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use
AES_128
as a derivation type for a BDK ofAES_128
orTDES_2KEY
If the service returns an enum value that is not available in the current SDK version,
dukptKeyDerivationType
will returnDukptDerivationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdukptKeyDerivationTypeAsString()
.- Returns:
- The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This
must be less than or equal to the strength of the BDK. For example, you can't use
AES_128
as a derivation type for a BDK ofAES_128
orTDES_2KEY
- See Also:
-
dukptKeyDerivationTypeAsString
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use
AES_128
as a derivation type for a BDK ofAES_128
orTDES_2KEY
If the service returns an enum value that is not available in the current SDK version,
dukptKeyDerivationType
will returnDukptDerivationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdukptKeyDerivationTypeAsString()
.- Returns:
- The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This
must be less than or equal to the strength of the BDK. For example, you can't use
AES_128
as a derivation type for a BDK ofAES_128
orTDES_2KEY
- See Also:
-
dukptKeyVariant
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
If the service returns an enum value that is not available in the current SDK version,
dukptKeyVariant
will returnDukptKeyVariant.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdukptKeyVariantAsString()
.- Returns:
- The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
- See Also:
-
dukptKeyVariantAsString
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
If the service returns an enum value that is not available in the current SDK version,
dukptKeyVariant
will returnDukptKeyVariant.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdukptKeyVariantAsString()
.- Returns:
- The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
- See Also:
-
initializationVector
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
- Returns:
- An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
-
keySerialNumber
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
- Returns:
- The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
-
mode
The block cipher method to use for encryption.
The default is CBC.
If the service returns an enum value that is not available in the current SDK version,
mode
will returnDukptEncryptionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The block cipher method to use for encryption.
The default is CBC.
- See Also:
-
modeAsString
The block cipher method to use for encryption.
The default is CBC.
If the service returns an enum value that is not available in the current SDK version,
mode
will returnDukptEncryptionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The block cipher method to use for encryption.
The default is CBC.
- See Also:
-
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 interfaceToCopyableBuilder<DukptEncryptionAttributes.Builder,
DukptEncryptionAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-