software.amazon.awssdk.services.kms.model

Class ReEncryptRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.ReEncryptRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReEncryptRequest
extends KmsRequest
implements ToCopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReEncryptRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ReEncryptRequest.Builder	builder()
SdkBytes	ciphertextBlob() Ciphertext of the data to reencrypt.
Map<String,String>	destinationEncryptionContext() Encryption context to use when the data is reencrypted.
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.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ReEncryptRequest.Builder>	serializableBuilderClass()
Map<String,String>	sourceEncryptionContext() Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ciphertextBlob

public SdkBytes ciphertextBlob()

Ciphertext of the data to reencrypt.

Returns:

Ciphertext of the data to reencrypt.

sourceEncryptionContext

public Map<String,String> sourceEncryptionContext()

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

destinationKeyId

public String destinationKeyId()

A unique identifier for the CMK that is used to reencrypt the data.

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.

Returns:

A unique identifier for the CMK that is used to reencrypt the data.

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.

destinationEncryptionContext

public Map<String,String> destinationEncryptionContext()

Encryption context to use when the data is reencrypted.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Encryption context to use when the data is reencrypted.

grantTokens

public 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.

Returns:

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

toBuilder

public ReEncryptRequest.Builder 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 interface ToCopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>

Specified by:

toBuilder in class KmsRequest

Returns:

a builder for type T

builder

public static ReEncryptRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ReEncryptRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.