software.amazon.awssdk.services.kms.model

Interface GenerateDataKeyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>, KmsRequest.Builder, SdkBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GenerateDataKeyRequest

public static interface GenerateDataKeyRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateDataKeyRequest.Builder,GenerateDataKeyRequest>

Method Summary

Modifier and Type	Method and Description
GenerateDataKeyRequest.Builder	encryptionContext(Map<String,String> encryptionContext) A set of key-value pairs that represents additional authenticated data.
GenerateDataKeyRequest.Builder	grantTokens(Collection<String> grantTokens) A list of grant tokens.
GenerateDataKeyRequest.Builder	grantTokens(String... grantTokens) A list of grant tokens.
GenerateDataKeyRequest.Builder	keyId(String keyId) An identifier for the CMK that encrypts the data key.
GenerateDataKeyRequest.Builder	keySpec(DataKeySpec keySpec) The length of the data key.
GenerateDataKeyRequest.Builder	keySpec(String keySpec) The length of the data key.
GenerateDataKeyRequest.Builder	numberOfBytes(Integer numberOfBytes) The length of the data key in bytes.
GenerateDataKeyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GenerateDataKeyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

keyId

GenerateDataKeyRequest.Builder keyId(String keyId)

An identifier for the CMK that encrypts the data 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.

Parameters:

keyId - An identifier for the CMK that encrypts the data 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:

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

encryptionContext

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

numberOfBytes

GenerateDataKeyRequest.Builder numberOfBytes(Integer numberOfBytes)

The length of the data 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 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.

keySpec

GenerateDataKeyRequest.Builder keySpec(String keySpec)

The length of the data 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 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, DataKeySpec

keySpec

GenerateDataKeyRequest.Builder keySpec(DataKeySpec keySpec)

The length of the data 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 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, DataKeySpec

grantTokens

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

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

overrideConfiguration

GenerateDataKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GenerateDataKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder