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

Interface GenerateDataKeyWithoutPlaintextRequest.Builder

All Superinterfaces:

CopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>, SdkBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>

Enclosing class:

GenerateDataKeyWithoutPlaintextRequest

public static interface GenerateDataKeyWithoutPlaintextRequest.Builder
extends CopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>

Method Summary

Modifier and Type	Method	Description
GenerateDataKeyWithoutPlaintextRequest.Builder	encryptionContext(Map<String,String> encryptionContext)	A set of key-value pairs that represents additional authenticated data.
GenerateDataKeyWithoutPlaintextRequest.Builder	grantTokens(String... grantTokens)	A list of grant tokens.
GenerateDataKeyWithoutPlaintextRequest.Builder	grantTokens(Collection<String> grantTokens)	A list of grant tokens.
GenerateDataKeyWithoutPlaintextRequest.Builder	keyId(String keyId)	The identifier of the CMK under which to generate and encrypt the data encryption key.
GenerateDataKeyWithoutPlaintextRequest.Builder	keySpec(String keySpec)	The length of the data encryption key.
GenerateDataKeyWithoutPlaintextRequest.Builder	keySpec(DataKeySpec keySpec)	The length of the data encryption key.
GenerateDataKeyWithoutPlaintextRequest.Builder	numberOfBytes(Integer numberOfBytes)	The length of the data encryption key in bytes.

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

copy

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

apply, build

Method Detail

keyId

GenerateDataKeyWithoutPlaintextRequest.Builder keyId(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

encryptionContext

GenerateDataKeyWithoutPlaintextRequest.Builder encryptionContext(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

keySpec

GenerateDataKeyWithoutPlaintextRequest.Builder keySpec(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataKeySpec

keySpec

GenerateDataKeyWithoutPlaintextRequest.Builder keySpec(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataKeySpec

numberOfBytes

GenerateDataKeyWithoutPlaintextRequest.Builder numberOfBytes(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

grantTokens

GenerateDataKeyWithoutPlaintextRequest.Builder grantTokens(Collection<String> grantTokens)

A list of grant tokens.

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

Parameters:

grantTokens - A list of grant tokens.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

grantTokens

GenerateDataKeyWithoutPlaintextRequest.Builder grantTokens(String... grantTokens)

A list of grant tokens.

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

NOTE: This method appends the values to the existing list (if any). Use #setGrantTokens(java.util.Collection) or #withGrantTokens(java.util.Collection) if you want to override the existing values.

Parameters:

grantTokens - A list of grant tokens.

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

Returns:

Returns a reference to this object so that method calls can be chained together.