@Generated(value="software.amazon.awssdk:codegen") public final class ReEncryptRequest extends KmsRequest implements ToCopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ReEncryptRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ReEncryptRequest.Builder |
builder() |
SdkBytes |
ciphertextBlob()
Ciphertext of the data to reencrypt.
|
EncryptionAlgorithmSpec |
destinationEncryptionAlgorithm()
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
|
String |
destinationEncryptionAlgorithmAsString()
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
|
Map<String,String> |
destinationEncryptionContext()
Specifies that encryption context to use when the reencrypting the data.
|
String |
destinationKeyId()
A unique identifier for the KMS key that is used to reencrypt the data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
List<String> |
grantTokens()
A list of grant tokens.
|
boolean |
hasDestinationEncryptionContext()
For responses, this returns true if the service returned a value for the DestinationEncryptionContext property.
|
boolean |
hasGrantTokens()
For responses, this returns true if the service returned a value for the GrantTokens property.
|
int |
hashCode() |
boolean |
hasSourceEncryptionContext()
For responses, this returns true if the service returned a value for the SourceEncryptionContext property.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ReEncryptRequest.Builder> |
serializableBuilderClass() |
EncryptionAlgorithmSpec |
sourceEncryptionAlgorithm()
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.
|
String |
sourceEncryptionAlgorithmAsString()
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.
|
Map<String,String> |
sourceEncryptionContext()
Specifies the encryption context to use to decrypt the ciphertext.
|
String |
sourceKeyId()
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.
|
ReEncryptRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final SdkBytes ciphertextBlob()
Ciphertext of the data to reencrypt.
public final boolean hasSourceEncryptionContext()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSourceEncryptionContext()
method.
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.
public final 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.
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.
public final 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.
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.
public final boolean hasDestinationEncryptionContext()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDestinationEncryptionContext()
method.
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.
public final 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.
If the service returns an enum value that is not available in the current SDK version,
sourceEncryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from sourceEncryptionAlgorithmAsString()
.
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
public final String sourceEncryptionAlgorithmAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
sourceEncryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from sourceEncryptionAlgorithmAsString()
.
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
public final 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.
If the service returns an enum value that is not available in the current SDK version,
destinationEncryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from destinationEncryptionAlgorithmAsString()
.
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
public final String destinationEncryptionAlgorithmAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
destinationEncryptionAlgorithm
will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from destinationEncryptionAlgorithmAsString()
.
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
public final boolean hasGrantTokens()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasGrantTokens()
method.
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.
public ReEncryptRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>
toBuilder
in class KmsRequest
public static ReEncryptRequest.Builder builder()
public static Class<? extends ReEncryptRequest.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)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.