Package software.amazon.awssdk.services.dynamodb.datamodeling

Class DynamoDbMapperConfig

java.lang.Object

software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbMapperConfig

public class DynamoDbMapperConfig
extends Object

Immutable configuration object for service call behavior. An instance of this configuration is supplied to every DynamoDbMapper at construction; if not provided explicitly, DEFAULT is used. New instances can be given to the mapper object on individual save, load, and delete operations to override the defaults. For example:

 DynamoDBMapper mapper = new DynamoDBMapper(dynamoDBClient);
 // Force this read to be consistent
 DomainClass obj = mapper.load(DomainClass.class, key, ConsistentReads.CONSISTENT.config());
 // Force this save operation to use putItem rather than updateItem
 mapper.save(obj, SaveBehavior.CLOBBER.config());
 // Save the object into a different table
 mapper.save(obj, new TableNameOverride("AnotherTable").config());
 // Delete the object even if the version field is out of date
 mapper.delete(obj, SaveBehavior.CLOBBER.config());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DynamoDbMapperConfig.BatchLoadRetryStrategy	DynamoDbMapper#batchLoad(List) breaks the requested items in batches of maximum size 100.
static interface	DynamoDbMapperConfig.BatchWriteRetryStrategy	DynamoDBMapper#batchWrite takes arbitrary number of save/delete requests and breaks them into smaller chunks that can be accepted by the service API.
static class	DynamoDbMapperConfig.Builder	A fluent builder for DynamoDBMapperConfig objects.
static class	DynamoDbMapperConfig.ConsistentReads	Enumeration of consistent read behavior.
static class	DynamoDbMapperConfig.DefaultBatchLoadRetryStrategy	This is the default strategy.
static class	DynamoDbMapperConfig.DefaultBatchWriteRetryStrategy	The default BatchWriteRetryStrategy which always retries on UnprocessedItem up to a maximum number of times and use exponential backoff with random scale factor.
static class	DynamoDbMapperConfig.DefaultTableNameResolver	Default implementation of DynamoDbMapperConfig.TableNameResolver that mimics the behavior of DynamoDBMapper before the addition of DynamoDbMapperConfig.TableNameResolver.
static class	DynamoDbMapperConfig.NoRetryBatchLoadRetryStrategy	This strategy, like name suggests will not attempt any retries on Unprocessed keys
static interface	DynamoDbMapperConfig.ObjectTableNameResolver	Interface for a strategy used to determine the table name of an object based on it's class.
static class	DynamoDbMapperConfig.PaginationLoadingStrategy	Enumeration of pagination loading strategy.
static class	DynamoDbMapperConfig.SaveBehavior	Enumeration of behaviors for the save operation.
static class	DynamoDbMapperConfig.TableNameOverride	Allows overriding the table name declared on a domain class by the DynamoDbTable annotation.
static interface	DynamoDbMapperConfig.TableNameResolver	Interface for a strategy used to determine the table name of an object based on it's class.

Field Summary

Fields

Modifier and Type	Field	Description
static DynamoDbMapperConfig	DEFAULT	Default configuration; these defaults are also applied by the mapper when only partial configurations are specified.

Constructor Summary

Constructors

Constructor	Description
DynamoDbMapperConfig(ConversionSchema conversionschema)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.ConsistentReads consistentReads)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.ObjectTableNameResolver objectTableNameResolver)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior, DynamoDbMapperConfig.ConsistentReads consistentReads, DynamoDbMapperConfig.TableNameOverride tableNameOverride)	Deprecated. in favor of the fluent DynamoDbMapperConfig.Builder
DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior, DynamoDbMapperConfig.ConsistentReads consistentReads, DynamoDbMapperConfig.TableNameOverride tableNameOverride, DynamoDbMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)	Deprecated. in favor of the fluent Builder
DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior, DynamoDbMapperConfig.ConsistentReads consistentReads, DynamoDbMapperConfig.TableNameOverride tableNameOverride, DynamoDbMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy, RequestMetricCollector requestMetricCollector)	Deprecated. in favor of the fluent Builder
DynamoDbMapperConfig(DynamoDbMapperConfig.TableNameOverride tableNameOverride)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.TableNameResolver tableNameResolver)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig.TableNameResolver tableNameResolver, DynamoDbMapperConfig.ObjectTableNameResolver objectTableNameResolver)	Deprecated.
DynamoDbMapperConfig(DynamoDbMapperConfig defaults, DynamoDbMapperConfig overrides)	Deprecated.

Method Summary

Modifier and Type	Method	Description
DynamoDbMapperConfig.BatchLoadRetryStrategy	batchLoadRetryStrategy()
DynamoDbMapperConfig.BatchWriteRetryStrategy	batchWriteRetryStrategy()
static DynamoDbMapperConfig.Builder	builder()	Creates a new empty builder.
DynamoDbMapperConfig.ConsistentReads	getConsistentReads()	Returns the consistent read behavior for this configuration.
ConversionSchema	getConversionSchema()
DynamoDbMapperConfig.ObjectTableNameResolver	getObjectTableNameResolver()	Returns the object table name resolver for this configuration.
DynamoDbMapperConfig.PaginationLoadingStrategy	getPaginationLoadingStrategy()	Returns the pagination loading strategy for this configuration.
RequestMetricCollector	getRequestMetricCollector()	Returns the request metric collector or null if not specified.
DynamoDbMapperConfig.TableNameOverride	getTableNameOverride()	Returns the table name override for this configuration.
DynamoDbMapperConfig.TableNameResolver	getTableNameResolver()	Returns the table name resolver for this configuration.
DynamoDbTypeConverterFactory	getTypeConverterFactory()
DynamoDbMapperConfig.SaveBehavior	saveBehavior()	Returns the save behavior for this configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final DynamoDbMapperConfig DEFAULT

Default configuration; these defaults are also applied by the mapper when only partial configurations are specified.

See Also:

DynamoDbMapperConfig.SaveBehavior.UPDATE, DynamoDbMapperConfig.ConsistentReads.EVENTUAL, DynamoDbMapperConfig.PaginationLoadingStrategy.LAZY_LOADING, DynamoDbMapperConfig.DefaultTableNameResolver.INSTANCE, DynamoDbMapperConfig.DefaultBatchWriteRetryStrategy.INSTANCE, DynamoDbMapperConfig.DefaultBatchLoadRetryStrategy.INSTANCE, DynamoDbTypeConverterFactory.standard(), ConversionSchemas.DEFAULT

Constructor Detail

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior,
                            DynamoDbMapperConfig.ConsistentReads consistentReads,
                            DynamoDbMapperConfig.TableNameOverride tableNameOverride)

Deprecated. in favor of the fluent DynamoDbMapperConfig.Builder

Legacy constructor, using default PaginationLoadingStrategy

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior,
                            DynamoDbMapperConfig.ConsistentReads consistentReads,
                            DynamoDbMapperConfig.TableNameOverride tableNameOverride,
                            DynamoDbMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)

Deprecated. in favor of the fluent Builder

Constructs a new configuration object with the save behavior, consistent read behavior, and table name override given.

Parameters:

saveBehavior - The DynamoDbMapperConfig.SaveBehavior to use, or null for default.

consistentReads - The DynamoDbMapperConfig.ConsistentReads to use, or null for default.

tableNameOverride - An override for the table name, or null for no override.

paginationLoadingStrategy - The pagination loading strategy, or null for default.

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior,
                            DynamoDbMapperConfig.ConsistentReads consistentReads,
                            DynamoDbMapperConfig.TableNameOverride tableNameOverride,
                            DynamoDbMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy,
                            RequestMetricCollector requestMetricCollector)

Deprecated. in favor of the fluent Builder

Constructs a new configuration object with the save behavior, consistent read behavior, and table name override given.

Parameters:

saveBehavior - The DynamoDbMapperConfig.SaveBehavior to use, or null for default.

consistentReads - The DynamoDbMapperConfig.ConsistentReads to use, or null for default.

tableNameOverride - An override for the table name, or null for no override.

paginationLoadingStrategy - The pagination loading strategy, or null for default.

requestMetricCollector - optional request metric collector

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.SaveBehavior saveBehavior)

Deprecated.

Constructs a new configuration object with the save behavior given.

See Also:

DynamoDbMapperConfig.SaveBehavior.config

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.ConsistentReads consistentReads)

Deprecated.

Constructs a new configuration object with the consistent read behavior given.

See Also:

DynamoDbMapperConfig.ConsistentReads.config

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.TableNameOverride tableNameOverride)

Deprecated.

Constructs a new configuration object with the table name override given.

See Also:

DynamoDbMapperConfig.TableNameOverride.config

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.TableNameResolver tableNameResolver)

Deprecated.

Constructs a new configuration object with the table name resolver strategy given.

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.ObjectTableNameResolver objectTableNameResolver)

Deprecated.

Constructs a new configuration object with the object table name resolver strategy given.

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.TableNameResolver tableNameResolver,
                            DynamoDbMapperConfig.ObjectTableNameResolver objectTableNameResolver)

Deprecated.

Constructs a new configuration object with the table name resolver strategies given.

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)

Deprecated.

Constructs a new configuration object with the pagination loading strategy given.

See Also:

DynamoDbMapperConfig.PaginationLoadingStrategy.config

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(ConversionSchema conversionschema)

Deprecated.

Constructs a new configuration object with the conversion schema given.

See Also:

DynamoDBConfig#builder

DynamoDbMapperConfig

@Deprecated
public DynamoDbMapperConfig(DynamoDbMapperConfig defaults,
                            DynamoDbMapperConfig overrides)

Deprecated.

Constructs a new configuration object from two others: a set of defaults and a set of overrides. Any non-null overrides will be applied to the defaults.

Used internally to merge the DynamoDbMapperConfig provided at construction with an overriding object for a particular operation.

Parameters:

defaults - The default mapper configuration values.

overrides - The overridden mapper configuration values. Any non-null config settings will be applied to the returned object.

See Also:

DynamoDBConfig#builder

Method Detail

builder

public static final DynamoDbMapperConfig.Builder builder()

Creates a new empty builder.

batchLoadRetryStrategy

public DynamoDbMapperConfig.BatchLoadRetryStrategy batchLoadRetryStrategy()

saveBehavior

public DynamoDbMapperConfig.SaveBehavior saveBehavior()

Returns the save behavior for this configuration.

getConsistentReads

public DynamoDbMapperConfig.ConsistentReads getConsistentReads()

Returns the consistent read behavior for this configuration.

getTableNameOverride

public DynamoDbMapperConfig.TableNameOverride getTableNameOverride()

Returns the table name override for this configuration. This value will override the table name specified in a DynamoDbTable annotation, either by replacing the table name entirely or else by pre-pending a string to each table name. This is useful for partitioning data in multiple tables at runtime.

See Also:

DynamoDbMapperConfig.TableNameOverride.withTableNamePrefix(String), DynamoDbMapperConfig.TableNameOverride.withTableNameReplacement(String)

getTableNameResolver

public DynamoDbMapperConfig.TableNameResolver getTableNameResolver()

Returns the table name resolver for this configuration. This value will be used to determine the table name for classes. It can be used for more powerful customization of table name than is possible using only DynamoDbMapperConfig.TableNameOverride.

See Also:

DynamoDbMapperConfig.TableNameResolver.getTableName(Class, DynamoDbMapperConfig)

getObjectTableNameResolver

public DynamoDbMapperConfig.ObjectTableNameResolver getObjectTableNameResolver()

Returns the object table name resolver for this configuration. This value will be used to determine the table name for objects. It can be used for more powerful customization of table name than is possible using only DynamoDbMapperConfig.TableNameOverride.

See Also:

DynamoDbMapperConfig.ObjectTableNameResolver.getTableName(Object, DynamoDbMapperConfig)

getPaginationLoadingStrategy

public DynamoDbMapperConfig.PaginationLoadingStrategy getPaginationLoadingStrategy()

Returns the pagination loading strategy for this configuration.

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

Returns the request metric collector or null if not specified.

getConversionSchema

public ConversionSchema getConversionSchema()

Returns:

the conversion schema for this config object

batchWriteRetryStrategy

public DynamoDbMapperConfig.BatchWriteRetryStrategy batchWriteRetryStrategy()

Returns:

the BatchWriteRetryStrategy for this config object

getTypeConverterFactory

public final DynamoDbTypeConverterFactory getTypeConverterFactory()

Returns:

the current type-converter factory