software.amazon.cryptography.dbencryptionsdk.dynamodb.model

Interface DynamoDbTableEncryptionConfig.Builder

Enclosing class:

DynamoDbTableEncryptionConfig

public static interface DynamoDbTableEncryptionConfig.Builder

Method Summary

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

Method Detail

logicalTableName

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

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

Parameters:

partitionKeyName - The name of the partition key on this table.

partitionKeyName

java.lang.String partitionKeyName()

Returns:

The name of the partition key on this table.

sortKeyName

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

Parameters:

sortKeyName - If this table contains a sort key, the name of the sort key on this table.

sortKeyName

java.lang.String sortKeyName()

Returns:

If this table contains a sort key, the name of the sort key on this table.

search

DynamoDbTableEncryptionConfig.Builder search(SearchConfig search)

Parameters:

search - The configuration for searchable encryption.

search

SearchConfig search()

Returns:

The configuration for searchable encryption.

attributeActionsOnEncrypt

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

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

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

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

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

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

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

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

DynamoDbTableEncryptionConfig build()