Class ReEncryptRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ReEncryptRequest.Builder,
ReEncryptRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReEncryptRequest.Builder
builder()
final SdkBytes
Ciphertext of the data to reencrypt.final EncryptionAlgorithmSpec
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.final String
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.Specifies that encryption context to use when the reencrypting the data.final String
A unique identifier for the KMS key that is used to reencrypt the data.final Boolean
dryRun()
Checks if your request will succeed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.A list of grant tokens.final boolean
For responses, this returns true if the service returned a value for the DestinationEncryptionContext property.final boolean
For responses, this returns true if the service returned a value for the GrantTokens property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SourceEncryptionContext property.static Class
<? extends ReEncryptRequest.Builder> final EncryptionAlgorithmSpec
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.final String
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.Specifies the encryption context to use to decrypt the ciphertext.final String
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ciphertextBlob
Ciphertext of the data to reencrypt.
- Returns:
- Ciphertext of the data to reencrypt.
-
hasSourceEncryptionContext
public final boolean hasSourceEncryptionContext()For responses, this returns true if the service returned a value for the SourceEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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.
-
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:
- 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.
-
-
-
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.
- Returns:
- 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.
-
-
-
hasDestinationEncryptionContext
public final boolean hasDestinationEncryptionContext()For responses, this returns true if the service returned a value for the DestinationEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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.- Returns:
- 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.
-
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 returnEncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceEncryptionAlgorithmAsString()
.- Returns:
- 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.
- See Also:
-
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 returnEncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceEncryptionAlgorithmAsString()
.- Returns:
- 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.
- 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.
If the service returns an enum value that is not available in the current SDK version,
destinationEncryptionAlgorithm
will returnEncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdestinationEncryptionAlgorithmAsString()
.- Returns:
- 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.
- See Also:
-
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 returnEncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdestinationEncryptionAlgorithmAsString()
.- Returns:
- 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.
- See Also:
-
hasGrantTokens
public final boolean hasGrantTokens()For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReEncryptRequest.Builder,
ReEncryptRequest> - Specified by:
toBuilder
in classKmsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-