@Generated(value="software.amazon.awssdk:codegen") public final class DecryptRequest extends KmsRequest implements ToCopyableBuilder<DecryptRequest.Builder,DecryptRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DecryptRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DecryptRequest.Builder |
builder() |
SdkBytes |
ciphertextBlob()
Ciphertext to be decrypted.
|
EncryptionAlgorithmSpec |
encryptionAlgorithm()
Specifies the encryption algorithm that will be used to decrypt the ciphertext.
|
String |
encryptionAlgorithmAsString()
Specifies the encryption algorithm that will be used to decrypt the ciphertext.
|
Map<String,String> |
encryptionContext()
Specifies the encryption context to use when decrypting the data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
List<String> |
grantTokens()
A list of grant tokens.
|
boolean |
hasEncryptionContext()
Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasGrantTokens()
Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
String |
keyId()
Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DecryptRequest.Builder> |
serializableBuilderClass() |
DecryptRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final SdkBytes ciphertextBlob()
Ciphertext to be decrypted. The blob includes metadata.
public final boolean hasEncryptionContext()
public final Map<String,String> encryptionContext()
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEncryptionContext()
to see if a value was sent in this field.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
public final boolean hasGrantTokens()
public final List<String> grantTokens()
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasGrantTokens()
to see if a value was sent in this field.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public final String keyId()
Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the CMK that you intend.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a CMK in a different AWS account, you must use the key ARN or
alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the CMK that you intend.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
alias name, prefix it with "alias/"
. To specify a CMK in a different AWS account, you must
use the key ARN or alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
public final EncryptionAlgorithmSpec encryptionAlgorithm()
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that
was used to encrypt the data. If you specify a different algorithm, the Decrypt
operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value,
SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid for symmetric CMKs.
If the service returns an enum value that is not available in the current SDK version,
encryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from encryptionAlgorithmAsString()
.
Decrypt
operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default
value, SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid for
symmetric CMKs.
EncryptionAlgorithmSpec
public final String encryptionAlgorithmAsString()
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that
was used to encrypt the data. If you specify a different algorithm, the Decrypt
operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value,
SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid for symmetric CMKs.
If the service returns an enum value that is not available in the current SDK version,
encryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from encryptionAlgorithmAsString()
.
Decrypt
operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default
value, SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid for
symmetric CMKs.
EncryptionAlgorithmSpec
public DecryptRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DecryptRequest.Builder,DecryptRequest>
toBuilder
in class KmsRequest
public static DecryptRequest.Builder builder()
public static Class<? extends DecryptRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.