Interface Key.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Key.Builder,
,Key> SdkBuilder<Key.Builder,
,Key> SdkPojo
- Enclosing class:
Key
-
Method Summary
Modifier and TypeMethodDescriptioncreateTimestamp
(Instant createTimestamp) The date and time when the key was created.deletePendingTimestamp
(Instant deletePendingTimestamp) The date and time after which Amazon Web Services Payment Cryptography will delete the key.deleteTimestamp
(Instant deleteTimestamp) The date and time after which Amazon Web Services Payment Cryptography will delete the key.Specifies whether the key is enabled.exportable
(Boolean exportable) Specifies whether the key is exportable.The Amazon Resource Name (ARN) of the key.default Key.Builder
keyAttributes
(Consumer<KeyAttributes.Builder> keyAttributes) The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.keyAttributes
(KeyAttributes keyAttributes) The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.keyCheckValue
(String keyCheckValue) The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.keyCheckValueAlgorithm
(String keyCheckValueAlgorithm) The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).keyCheckValueAlgorithm
(KeyCheckValueAlgorithm keyCheckValueAlgorithm) The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).The source of the key material.The source of the key material.The state of key that is being created or deleted.The state of key that is being created or deleted.usageStartTimestamp
(Instant usageStartTimestamp) The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.usageStopTimestamp
(Instant usageStopTimestamp) The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
keyArn
The Amazon Resource Name (ARN) of the key.
- Parameters:
keyArn
- The Amazon Resource Name (ARN) of the key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyAttributes
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
- Parameters:
keyAttributes
- The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyAttributes
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
This is a convenience method that creates an instance of theKeyAttributes.Builder
avoiding the need to create one manually viaKeyAttributes.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokeyAttributes(KeyAttributes)
.- Parameters:
keyAttributes
- a consumer that will call methods onKeyAttributes.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyCheckValue
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
- Parameters:
keyCheckValue
- The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyCheckValueAlgorithm
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
- Parameters:
keyCheckValueAlgorithm
- The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyCheckValueAlgorithm
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
- Parameters:
keyCheckValueAlgorithm
- The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enabled
Specifies whether the key is enabled.
- Parameters:
enabled
- Specifies whether the key is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportable
Specifies whether the key is exportable. This data is immutable after the key is created.
- Parameters:
exportable
- Specifies whether the key is exportable. This data is immutable after the key is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyState
The state of key that is being created or deleted.
- Parameters:
keyState
- The state of key that is being created or deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyState
The state of key that is being created or deleted.
- Parameters:
keyState
- The state of key that is being created or deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyOrigin
The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is
AWS_PAYMENT_CRYPTOGRAPHY
. For keys imported into Amazon Web Services Payment Cryptography, the value isEXTERNAL
.- Parameters:
keyOrigin
- The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value isAWS_PAYMENT_CRYPTOGRAPHY
. For keys imported into Amazon Web Services Payment Cryptography, the value isEXTERNAL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyOrigin
The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is
AWS_PAYMENT_CRYPTOGRAPHY
. For keys imported into Amazon Web Services Payment Cryptography, the value isEXTERNAL
.- Parameters:
keyOrigin
- The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value isAWS_PAYMENT_CRYPTOGRAPHY
. For keys imported into Amazon Web Services Payment Cryptography, the value isEXTERNAL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createTimestamp
The date and time when the key was created.
- Parameters:
createTimestamp
- The date and time when the key was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
usageStartTimestamp
The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
- Parameters:
usageStartTimestamp
- The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
usageStopTimestamp
The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
- Parameters:
usageStopTimestamp
- The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deletePendingTimestamp
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when
KeyState
isDELETE_PENDING
and the key is scheduled for deletion.- Parameters:
deletePendingTimestamp
- The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only whenKeyState
isDELETE_PENDING
and the key is scheduled for deletion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleteTimestamp
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the
KeyState
isDELETE_COMPLETE
and the Amazon Web Services Payment Cryptography key is deleted.- Parameters:
deleteTimestamp
- The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when theKeyState
isDELETE_COMPLETE
and the Amazon Web Services Payment Cryptography key is deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-