software.amazon.cryptography.dbencryptionsdk.dynamodb.itemencryptor.model

Class DynamoDbItemEncryptorConfig

java.lang.Object

software.amazon.cryptography.dbencryptionsdk.dynamodb.itemencryptor.model.DynamoDbItemEncryptorConfig

public class DynamoDbItemEncryptorConfig
extends java.lang.Object

The configuration for the client-side encryption of DynamoDB items.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DynamoDbItemEncryptorConfig.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DynamoDbItemEncryptorConfig(software.amazon.cryptography.dbencryptionsdk.dynamodb.itemencryptor.model.DynamoDbItemEncryptorConfig.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
software.amazon.cryptography.materialproviders.model.DBEAlgorithmSuiteId	algorithmSuiteId()
java.lang.String	allowedUnsignedAttributePrefix()
java.util.List<java.lang.String>	allowedUnsignedAttributes()
java.util.Map<java.lang.String,CryptoAction>	attributeActionsOnEncrypt()
static DynamoDbItemEncryptorConfig.Builder	builder()
software.amazon.cryptography.materialproviders.ICryptographicMaterialsManager	cmm()
software.amazon.cryptography.materialproviders.IKeyring	keyring()
LegacyOverride	legacyOverride()
java.lang.String	logicalTableName()
java.lang.String	partitionKeyName()
PlaintextOverride	plaintextOverride()
java.lang.String	sortKeyName()
DynamoDbItemEncryptorConfig.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamoDbItemEncryptorConfig

protected DynamoDbItemEncryptorConfig(software.amazon.cryptography.dbencryptionsdk.dynamodb.itemencryptor.model.DynamoDbItemEncryptorConfig.BuilderImpl builder)

Method Detail

logicalTableName

public java.lang.String logicalTableName()

Returns:

The logical table name for this table. This is the name that is cryptographically bound with your data. This can be the same as the actual DynamoDB table name. It's purpose is to be distinct from the DynamoDB table name so that the data may still be authenticated if being read from different (but logically similar) tables, such as a backup table.

partitionKeyName

public java.lang.String partitionKeyName()

Returns:

The name of the partition key on the table this item will be written to or was read from.

sortKeyName

public java.lang.String sortKeyName()

Returns:

If this table contains a sort key, the name of the sort key on the table this item will be written to or was read from.

attributeActionsOnEncrypt

public java.util.Map<java.lang.String,CryptoAction> attributeActionsOnEncrypt()

Returns:

A map that describes what attributes should be encrypted and/or signed on encrypt. This map must contain all attributes that might be encountered during encryption.

allowedUnsignedAttributes

public java.util.List<java.lang.String> allowedUnsignedAttributes()

Returns:

A list of attribute names such that, if encountered during decryption, those attributes are treated as unsigned.

allowedUnsignedAttributePrefix

public java.lang.String allowedUnsignedAttributePrefix()

Returns:

A prefix such that, if during decryption any attribute has a name with this prefix, it is treated as unsigned.

algorithmSuiteId

public software.amazon.cryptography.materialproviders.model.DBEAlgorithmSuiteId algorithmSuiteId()

Returns:

An ID for the algorithm suite to use during encryption and decryption.

keyring

public software.amazon.cryptography.materialproviders.IKeyring keyring()

Returns:

The Keyring that should be used to wrap and unwrap data keys. If specified a Default Cryptographic Materials Manager with this Keyring is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.

cmm

public software.amazon.cryptography.materialproviders.ICryptographicMaterialsManager cmm()

Returns:

The Cryptographic Materials Manager that is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.

legacyOverride

public LegacyOverride legacyOverride()

Returns:

A configuration that override encryption and/or decryption to instead perform legacy encryption and/or decryption. Used as part of migration from version 2.x to version 3.x.

plaintextOverride

public PlaintextOverride plaintextOverride()

Returns:

A configuration that override encryption and/or decryption to instead passthrough and write and/or read plaintext. Used to update plaintext tables to fully use client-side encryption.

toBuilder

public DynamoDbItemEncryptorConfig.Builder toBuilder()

builder

public static DynamoDbItemEncryptorConfig.Builder builder()