software.amazon.awssdk.services.kms.model

Class GenerateDataKeyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GenerateDataKeyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GenerateDataKeyRequest.Builder	builder()
Map<String,String>	encryptionContext() A set of key-value pairs that represents additional authenticated data.
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() The identifier of the CMK under which to generate and encrypt the data encryption key.
DataKeySpec	keySpec() The length of the data encryption key.
String	keySpecAsString() The length of the data encryption key.
Integer	numberOfBytes() The length of the data encryption key in bytes.
List<SdkField<?>>	sdkFields()
static Class<? extends GenerateDataKeyRequest.Builder>	serializableBuilderClass()
GenerateDataKeyRequest.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()

The identifier of the CMK under which to generate and encrypt the data encryption key.

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:

The identifier of the CMK under which to generate and encrypt the data encryption key.

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.

encryptionContext

public Map<String,String> encryptionContext()

A set of key-value pairs that represents additional authenticated data.

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.

Returns:

A set of key-value pairs that represents additional authenticated data.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

numberOfBytes

public Integer numberOfBytes()

The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

Returns:

The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

keySpec

public DataKeySpec keySpec()

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

If the service returns an enum value that is not available in the current SDK version, keySpec will return DataKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keySpecAsString().

Returns:

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

See Also:

DataKeySpec

keySpecAsString

public String keySpecAsString()

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

If the service returns an enum value that is not available in the current SDK version, keySpec will return DataKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keySpecAsString().

Returns:

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

See Also:

DataKeySpec

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

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static GenerateDataKeyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GenerateDataKeyRequest.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