@Generated(value="software.amazon.awssdk:codegen") public final class CreateKeyRequest extends PaymentCryptographyRequest implements ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateKeyRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateKeyRequest.Builder |
builder() |
Boolean |
enabled()
Specifies whether to enable the key.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Boolean |
exportable()
Specifies whether the key is exportable from the service.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
KeyAttributes |
keyAttributes()
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
|
KeyCheckValueAlgorithm |
keyCheckValueAlgorithm()
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES
and AES keys.
|
String |
keyCheckValueAlgorithmAsString()
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES
and AES keys.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateKeyRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The tags to attach to the key.
|
CreateKeyRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Boolean enabled()
Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
public final Boolean exportable()
Specifies whether the key is exportable from the service.
public final KeyAttributes 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.
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().
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.
KeyCheckValueAlgorithmpublic 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().
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.
KeyCheckValueAlgorithmpublic final boolean hasTags()
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.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.
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.
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.
public CreateKeyRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>toBuilder in class PaymentCryptographyRequestpublic static CreateKeyRequest.Builder builder()
public static Class<? extends CreateKeyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.