software.amazon.awssdk.services.kms.model

Class EncryptRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EncryptRequest.Builder,EncryptRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EncryptRequest.Builder

Method Summary

Modifier and Type	Method and Description
static EncryptRequest.Builder	builder()
Map<String,String>	encryptionContext() Name-value pair that specifies the encryption context to be used for authenticated encryption.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	grantTokens() A list of grant tokens.
int	hashCode()
String	keyId() A unique identifier for the customer master key (CMK).
SdkBytes	plaintext() Data to be encrypted.
List<SdkField<?>>	sdkFields()
static Class<? extends EncryptRequest.Builder>	serializableBuilderClass()
EncryptRequest.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

keyId

public String keyId()

A unique identifier for the customer master key (CMK).

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 customer master key (CMK).

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.

plaintext

public SdkBytes plaintext()

Data to be encrypted.

Returns:

Data to be encrypted.

encryptionContext

public Map<String,String> encryptionContext()

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

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

Returns:

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

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 EncryptRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptRequest.Builder,EncryptRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static EncryptRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo