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

Interface EncryptRequest.Builder

All Superinterfaces:

CopyableBuilder<EncryptRequest.Builder,EncryptRequest>, SdkBuilder<EncryptRequest.Builder,EncryptRequest>

Enclosing class:

EncryptRequest

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

Method Summary

Modifier and Type	Method	Description
EncryptRequest.Builder	encryptionContext(Map<String,String> encryptionContext)	Name-value pair that specifies the encryption context to be used for authenticated encryption.
EncryptRequest.Builder	grantTokens(String... grantTokens)	A list of grant tokens.
EncryptRequest.Builder	grantTokens(Collection<String> grantTokens)	A list of grant tokens.
EncryptRequest.Builder	keyId(String keyId)	A unique identifier for the customer master key.
EncryptRequest.Builder	plaintext(ByteBuffer plaintext)	Data to be encrypted.

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

EncryptRequest.Builder keyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

• Alias Name Example - alias/MyAliasName

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

• Alias Name Example - alias/MyAliasName

Returns:

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

plaintext

EncryptRequest.Builder plaintext(ByteBuffer plaintext)

Data to be encrypted.

Parameters:

plaintext - Data to be encrypted.

Returns:

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

encryptionContext

EncryptRequest.Builder encryptionContext(Map<String,String> encryptionContext)

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

Parameters:

encryptionContext - Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

Returns:

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

grantTokens

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

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