Package software.amazon.awssdk.services.kms.model

Class GenerateDataKeyRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kms.model.GenerateDataKeyRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateDataKeyRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GenerateDataKeyRequest.Builder	builder()
Map<String,String>	encryptionContext()	A set of key-value pairs that represents additional authenticated data.
boolean	equals(Object obj)
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.
String	keySpec()	The length of the data encryption key.
Integer	numberOfBytes()	The length of the data encryption key in bytes.
static Class<? extends GenerateDataKeyRequest.Builder>	serializableBuilderClass()
GenerateDataKeyRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

keyId

public String keyId()

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

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• CMK 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

Returns:

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

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• CMK 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

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.

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

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.

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()

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

Returns:

a builder for type T

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()

Overrides:

toString in class Object