software.amazon.awssdk.services.kms.model

Interface ReEncryptRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>, KmsRequest.Builder, SdkBuilder<ReEncryptRequest.Builder,ReEncryptRequest>, SdkRequest.Builder

Enclosing class:

ReEncryptRequest

public static interface ReEncryptRequest.Builder
extends KmsRequest.Builder, CopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>

Method Summary

Modifier and Type	Method and Description
ReEncryptRequest.Builder	ciphertextBlob(SdkBytes ciphertextBlob) Ciphertext of the data to reencrypt.
ReEncryptRequest.Builder	destinationEncryptionContext(Map<String,String> destinationEncryptionContext) Encryption context to use when the data is reencrypted.
ReEncryptRequest.Builder	destinationKeyId(String destinationKeyId) A unique identifier for the CMK that is used to reencrypt the data.
ReEncryptRequest.Builder	grantTokens(Collection<String> grantTokens) A list of grant tokens.
ReEncryptRequest.Builder	grantTokens(String... grantTokens) A list of grant tokens.
ReEncryptRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ReEncryptRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ReEncryptRequest.Builder	sourceEncryptionContext(Map<String,String> sourceEncryptionContext) Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

Method Detail

ciphertextBlob

ReEncryptRequest.Builder ciphertextBlob(SdkBytes ciphertextBlob)

Ciphertext of the data to reencrypt.

Parameters:

ciphertextBlob - Ciphertext of the data to reencrypt.

Returns:

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

sourceEncryptionContext

ReEncryptRequest.Builder sourceEncryptionContext(Map<String,String> sourceEncryptionContext)

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Parameters:

sourceEncryptionContext - Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Returns:

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

destinationKeyId

ReEncryptRequest.Builder destinationKeyId(String destinationKeyId)

A unique identifier for the CMK that is used to reencrypt the data.

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:

destinationKeyId - A unique identifier for the CMK that is used to reencrypt the data.

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.

destinationEncryptionContext

ReEncryptRequest.Builder destinationEncryptionContext(Map<String,String> destinationEncryptionContext)

Encryption context to use when the data is reencrypted.

Parameters:

destinationEncryptionContext - Encryption context to use when the data is reencrypted.

Returns:

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

grantTokens

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

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

ReEncryptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.