@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 AWS KMS will use to reecrypt the data after it has decrypted it.
|
String |
destinationEncryptionAlgorithmAsString()
Specifies the encryption algorithm that AWS 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 CMK that is used to reencrypt the data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
List<String> |
grantTokens()
A list of grant tokens.
|
boolean |
hasDestinationEncryptionContext()
Returns true if the DestinationEncryptionContext property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
boolean |
hasGrantTokens()
Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasSourceEncryptionContext()
Returns true if the SourceEncryptionContext property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ReEncryptRequest.Builder> |
serializableBuilderClass() |
EncryptionAlgorithmSpec |
sourceEncryptionAlgorithm()
Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted.
|
String |
sourceEncryptionAlgorithmAsString()
Specifies the encryption algorithm that AWS 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 customer master key (CMK) that AWS KMS will use to decrypt the ciphertext before it is
re-encrypted.
|
ReEncryptRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final SdkBytes ciphertextBlob()
Ciphertext of the data to reencrypt.
public final boolean hasSourceEncryptionContext()
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 represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSourceEncryptionContext()
to see if a value was sent in this field.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
public final String sourceKeyId()
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the CMK that was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
alias name, prefix it with "alias/"
. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
public final String destinationKeyId()
A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or asymmetric CMK with a
KeyUsage
value of ENCRYPT_DECRYPT
. To find the KeyUsage
value of a CMK,
use the DescribeKey operation.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a CMK in a different AWS 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 CMK, 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 CMK, use the DescribeKey operation.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
alias name, prefix it with "alias/"
. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
public final boolean hasDestinationEncryptionContext()
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 CMK is a symmetric CMK. The standard ciphertext format for asymmetric CMKs does not include fields for metadata.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDestinationEncryptionContext()
to see if a value was sent in this field.
A destination encryption context is valid only when the destination CMK is a symmetric CMK. The standard ciphertext format for asymmetric CMKs does not include fields for metadata.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
public final EncryptionAlgorithmSpec sourceEncryptionAlgorithm()
Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted. The
default value, SYMMETRIC_DEFAULT
, represents the algorithm used for symmetric CMKs.
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 CMK.
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 CMKs.
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 CMK.
EncryptionAlgorithmSpec
public final String sourceEncryptionAlgorithmAsString()
Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted. The
default value, SYMMETRIC_DEFAULT
, represents the algorithm used for symmetric CMKs.
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 CMK.
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 CMKs.
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 CMK.
EncryptionAlgorithmSpec
public final EncryptionAlgorithmSpec destinationEncryptionAlgorithm()
Specifies the encryption algorithm that AWS KMS will use to reecrypt the data after it has decrypted it. The
default value, SYMMETRIC_DEFAULT
, represents the encryption algorithm used for symmetric CMKs.
This parameter is required only when the destination CMK is an asymmetric CMK.
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
CMKs.
This parameter is required only when the destination CMK is an asymmetric CMK.
EncryptionAlgorithmSpec
public final String destinationEncryptionAlgorithmAsString()
Specifies the encryption algorithm that AWS KMS will use to reecrypt the data after it has decrypted it. The
default value, SYMMETRIC_DEFAULT
, represents the encryption algorithm used for symmetric CMKs.
This parameter is required only when the destination CMK is an asymmetric CMK.
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
CMKs.
This parameter is required only when the destination CMK is an asymmetric CMK.
EncryptionAlgorithmSpec
public final boolean hasGrantTokens()
public final List<String> grantTokens()
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasGrantTokens()
to see if a value was sent in this field.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public ReEncryptRequest.Builder toBuilder()
ToCopyableBuilder
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)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.