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

Interface DynamoDbItemEncryptorConfig.Builder

Enclosing class:

DynamoDbItemEncryptorConfig

public static interface DynamoDbItemEncryptorConfig.Builder

Method Summary

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

Method Detail

logicalTableName

DynamoDbItemEncryptorConfig.Builder logicalTableName(java.lang.String logicalTableName)

Parameters:

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

logicalTableName

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

DynamoDbItemEncryptorConfig.Builder partitionKeyName(java.lang.String partitionKeyName)

Parameters:

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

partitionKeyName

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

DynamoDbItemEncryptorConfig.Builder sortKeyName(java.lang.String sortKeyName)

Parameters:

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

sortKeyName

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

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

Parameters:

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

attributeActionsOnEncrypt

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

DynamoDbItemEncryptorConfig.Builder allowedUnsignedAttributes(java.util.List<java.lang.String> allowedUnsignedAttributes)

Parameters:

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

allowedUnsignedAttributes

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

DynamoDbItemEncryptorConfig.Builder allowedUnsignedAttributePrefix(java.lang.String allowedUnsignedAttributePrefix)

Parameters:

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

allowedUnsignedAttributePrefix

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

DynamoDbItemEncryptorConfig.Builder algorithmSuiteId(software.amazon.cryptography.materialproviders.model.DBEAlgorithmSuiteId algorithmSuiteId)

Parameters:

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

algorithmSuiteId

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

Returns:

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

keyring

DynamoDbItemEncryptorConfig.Builder keyring(software.amazon.cryptography.materialproviders.IKeyring keyring)

Parameters:

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

keyring

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

DynamoDbItemEncryptorConfig.Builder cmm(software.amazon.cryptography.materialproviders.ICryptographicMaterialsManager cmm)

Parameters:

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

cmm

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

DynamoDbItemEncryptorConfig.Builder legacyOverride(LegacyOverride legacyOverride)

Parameters:

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

legacyOverride

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

DynamoDbItemEncryptorConfig.Builder plaintextOverride(PlaintextOverride plaintextOverride)

Parameters:

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

plaintextOverride

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.

build

DynamoDbItemEncryptorConfig build()