public static interface ReEncryptRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>
Modifier and Type | Method and Description |
---|---|
ReEncryptRequest.Builder |
ciphertextBlob(SdkBytes ciphertextBlob)
Ciphertext of the data to reencrypt.
|
ReEncryptRequest.Builder |
destinationEncryptionAlgorithm(EncryptionAlgorithmSpec destinationEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
|
ReEncryptRequest.Builder |
destinationEncryptionAlgorithm(String destinationEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
|
ReEncryptRequest.Builder |
destinationEncryptionContext(Map<String,String> destinationEncryptionContext)
Specifies that encryption context to use when the reencrypting the data.
|
ReEncryptRequest.Builder |
destinationKeyId(String destinationKeyId)
A unique identifier for the KMS key that is used to reencrypt the data.
|
ReEncryptRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
ReEncryptRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
ReEncryptRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ReEncryptRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ReEncryptRequest.Builder |
sourceEncryptionAlgorithm(EncryptionAlgorithmSpec sourceEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.
|
ReEncryptRequest.Builder |
sourceEncryptionAlgorithm(String sourceEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.
|
ReEncryptRequest.Builder |
sourceEncryptionContext(Map<String,String> sourceEncryptionContext)
Specifies the encryption context to use to decrypt the ciphertext.
|
ReEncryptRequest.Builder |
sourceKeyId(String sourceKeyId)
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ReEncryptRequest.Builder ciphertextBlob(SdkBytes ciphertextBlob)
Ciphertext of the data to reencrypt.
ciphertextBlob
- Ciphertext of the data to reencrypt.ReEncryptRequest.Builder sourceEncryptionContext(Map<String,String> sourceEncryptionContext)
Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.
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.
sourceEncryptionContext
- Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context
that was used to encrypt the ciphertext.
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.
ReEncryptRequest.Builder sourceKeyId(String sourceKeyId)
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.
Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key,
the ReEncrypt
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.
sourceKeyId
- Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.
Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS
key, the ReEncrypt
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.
ReEncryptRequest.Builder destinationKeyId(String destinationKeyId)
A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric encryption KMS
key or an asymmetric KMS key with a KeyUsage
value of ENCRYPT_DECRYPT
. To find the
KeyUsage
value 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.
destinationKeyId
- A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric encryption
KMS key or an asymmetric KMS key with a KeyUsage
value of ENCRYPT_DECRYPT
.
To find the KeyUsage
value 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.
ReEncryptRequest.Builder destinationEncryptionContext(Map<String,String> destinationEncryptionContext)
Specifies that encryption context to use when the reencrypting the data.
A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
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.
destinationEncryptionContext
- Specifies that encryption context to use when the reencrypting the data.
A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
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.
ReEncryptRequest.Builder sourceEncryptionAlgorithm(String sourceEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The
default value, SYMMETRIC_DEFAULT
, represents the algorithm used for symmetric encryption KMS
keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
sourceEncryptionAlgorithm
- Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is
reencrypted. The default value, SYMMETRIC_DEFAULT
, represents the algorithm used for
symmetric encryption KMS keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
ReEncryptRequest.Builder sourceEncryptionAlgorithm(EncryptionAlgorithmSpec sourceEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The
default value, SYMMETRIC_DEFAULT
, represents the algorithm used for symmetric encryption KMS
keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
sourceEncryptionAlgorithm
- Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is
reencrypted. The default value, SYMMETRIC_DEFAULT
, represents the algorithm used for
symmetric encryption KMS keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
ReEncryptRequest.Builder destinationEncryptionAlgorithm(String destinationEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The
default value, SYMMETRIC_DEFAULT
, represents the encryption algorithm used for symmetric
encryption KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
destinationEncryptionAlgorithm
- Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
The default value, SYMMETRIC_DEFAULT
, represents the encryption algorithm used for
symmetric encryption KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
ReEncryptRequest.Builder destinationEncryptionAlgorithm(EncryptionAlgorithmSpec destinationEncryptionAlgorithm)
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The
default value, SYMMETRIC_DEFAULT
, represents the encryption algorithm used for symmetric
encryption KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
destinationEncryptionAlgorithm
- Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
The default value, SYMMETRIC_DEFAULT
, represents the encryption algorithm used for
symmetric encryption KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
EncryptionAlgorithmSpec
,
EncryptionAlgorithmSpec
ReEncryptRequest.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.
ReEncryptRequest.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.
ReEncryptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
ReEncryptRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.