public static interface DecryptRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<DecryptRequest.Builder,DecryptRequest>
Modifier and Type | Method and Description |
---|---|
DecryptRequest.Builder |
ciphertextBlob(SdkBytes ciphertextBlob)
Ciphertext to be decrypted.
|
DecryptRequest.Builder |
encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
Specifies the encryption algorithm that will be used to decrypt the ciphertext.
|
DecryptRequest.Builder |
encryptionAlgorithm(String encryptionAlgorithm)
Specifies the encryption algorithm that will be used to decrypt the ciphertext.
|
DecryptRequest.Builder |
encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context to use when decrypting the data.
|
DecryptRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
DecryptRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
DecryptRequest.Builder |
keyId(String keyId)
Specifies the KMS key that KMS uses to decrypt the ciphertext.
|
DecryptRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
DecryptRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
DecryptRequest.Builder ciphertextBlob(SdkBytes ciphertextBlob)
Ciphertext to be decrypted. The blob includes metadata.
ciphertextBlob
- Ciphertext to be decrypted. The blob includes metadata.DecryptRequest.Builder encryptionContext(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 encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
encryptionContext
- Specifies the encryption context to use when decrypting the data. An encryption context is valid only
for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption
algorithms and HMAC algorithms that KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
DecryptRequest.Builder grantTokens(Collection<String> grantTokens)
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
grantTokens
- A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
DecryptRequest.Builder grantTokens(String... grantTokens)
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
grantTokens
- A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
DecryptRequest.Builder keyId(String keyId)
Specifies the KMS key that KMS uses to decrypt the ciphertext.
Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key,
the Decrypt
operation throws an IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key 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 KMS key that you intend.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it
with "alias/"
. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
keyId
- Specifies the KMS key that KMS uses to decrypt the ciphertext.
Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS
key, the Decrypt
operation throws an IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key 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 KMS key that you intend.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
DecryptRequest.Builder encryptionAlgorithm(String 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 KMS key. The default
value, SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid for symmetric
encryption KMS keys.
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 KMS key. The
default value, SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid
for symmetric encryption KMS keys.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
DecryptRequest.Builder encryptionAlgorithm(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 KMS key. The default
value, SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid for symmetric
encryption KMS keys.
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 KMS key. The
default value, SYMMETRIC_DEFAULT
, represents the only supported algorithm that is valid
for symmetric encryption KMS keys.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
DecryptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
DecryptRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.