public static interface EncryptRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<EncryptRequest.Builder,EncryptRequest>
Modifier and Type | Method and Description |
---|---|
EncryptRequest.Builder |
encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
EncryptRequest.Builder |
encryptionAlgorithm(String encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
EncryptRequest.Builder |
encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used to encrypt the data.
|
EncryptRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
EncryptRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
EncryptRequest.Builder |
keyId(String keyId)
Identifies the KMS key to use in the encryption operation.
|
EncryptRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
EncryptRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
EncryptRequest.Builder |
plaintext(SdkBytes plaintext)
Data to be encrypted.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
EncryptRequest.Builder keyId(String keyId)
Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage
of
ENCRYPT_DECRYPT
. To find the KeyUsage
of a KMS key, use the DescribeKey
operation.
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
- Identifies the KMS key to use in the encryption operation. The KMS key must have a
KeyUsage
of ENCRYPT_DECRYPT
. To find the KeyUsage
of a KMS key,
use the DescribeKey operation.
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.
EncryptRequest.Builder plaintext(SdkBytes plaintext)
Data to be encrypted.
plaintext
- Data to be encrypted.EncryptRequest.Builder encryptionContext(Map<String,String> encryptionContext)
Specifies the encryption context that will be used to encrypt 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 that will be used to encrypt 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.
EncryptRequest.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.
EncryptRequest.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.
EncryptRequest.Builder encryptionAlgorithm(String encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT
,
is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend
RSAES_OAEP_SHA_256.
encryptionAlgorithm
- Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm
must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value,
SYMMETRIC_DEFAULT
, is the algorithm used for symmetric encryption KMS keys. If you are
using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
EncryptRequest.Builder encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT
,
is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend
RSAES_OAEP_SHA_256.
encryptionAlgorithm
- Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm
must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value,
SYMMETRIC_DEFAULT
, is the algorithm used for symmetric encryption KMS keys. If you are
using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
EncryptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
EncryptRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.