Interface ReEncryptRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ReEncryptRequest.Builder,
,ReEncryptRequest> KmsRequest.Builder
,SdkBuilder<ReEncryptRequest.Builder,
,ReEncryptRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ReEncryptRequest
-
Method Summary
Modifier and TypeMethodDescriptionciphertextBlob
(SdkBytes ciphertextBlob) Ciphertext of the data to reencrypt.destinationEncryptionAlgorithm
(String destinationEncryptionAlgorithm) Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.destinationEncryptionAlgorithm
(EncryptionAlgorithmSpec destinationEncryptionAlgorithm) Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.destinationEncryptionContext
(Map<String, String> destinationEncryptionContext) Specifies that encryption context to use when the reencrypting the data.destinationKeyId
(String destinationKeyId) A unique identifier for the KMS key that is used to reencrypt the data.Checks if your request will succeed.grantTokens
(String... grantTokens) A list of grant tokens.grantTokens
(Collection<String> grantTokens) A list of grant tokens.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sourceEncryptionAlgorithm
(String sourceEncryptionAlgorithm) Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.sourceEncryptionAlgorithm
(EncryptionAlgorithmSpec sourceEncryptionAlgorithm) Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.sourceEncryptionContext
(Map<String, String> sourceEncryptionContext) Specifies the encryption context to use to decrypt the ciphertext.sourceKeyId
(String sourceKeyId) Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
ciphertextBlob
Ciphertext of the data to reencrypt.
- Parameters:
ciphertextBlob
- Ciphertext of the data to reencrypt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 anIncorrectKeyException
.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.
- Parameters:
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 anIncorrectKeyException
.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 ofENCRYPT_DECRYPT
. To find theKeyUsage
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.
- Parameters:
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 aKeyUsage
value ofENCRYPT_DECRYPT
. To find theKeyUsage
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
destinationEncryptionContext
ReEncryptRequest.Builder destinationEncryptionContext(Map<String, String> destinationEncryptionContext) Specifies that encryption context to use when the reencrypting the data.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
- Parameters:
destinationEncryptionContext
- Specifies that encryption context to use when the reencrypting the data.Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceEncryptionAlgorithm
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
destinationEncryptionAlgorithm
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
Checks if your request will succeed.
DryRun
is an optional parameter.To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
- Parameters:
dryRun
- Checks if your request will succeed.DryRun
is an optional parameter.To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ReEncryptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ReEncryptRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-