DynamoDB¶
Since v0.34.0
Introduction¶
The Testcontainers module for DynamoDB.
Adding this module to your project dependencies¶
Please run the following command to add the DynamoDB module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/dynamodb
Usage example¶
ctx := context.Background()
ctr, err := tcdynamodb.Run(ctx, "amazon/dynamodb-local:2.2.1")
defer func() {
if err := testcontainers.TerminateContainer(ctr); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to run dynamodb container: %s", err)
return
}
Module Reference¶
Run function¶
- Since v0.34.0
The DynamoDB module exposes one entrypoint function to create the DynamoDB container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DynamoDBContainer, error)
context.Context
, the Go context.string
, the Docker image to use.testcontainers.ContainerCustomizer
, a variadic argument for passing options.
Image¶
Use the second argument in the Run
function to set a valid Docker image.
In example: Run(context.Background(), "amazon/dynamodb-local:2.2.1")
.
Container Options¶
When starting the DynamoDB container, you can pass options in a variadic way to configure it.
WithSharedDB¶
- Since v0.34.0
The WithSharedDB
option tells the DynamoDB container to use a single database file. At the same time, it marks the container as reusable, which causes that successive calls to the Run
function will return the same container instance, and therefore, the same database file.
WithDisableTelemetry¶
- Since v0.34.0
You can turn off telemetry when starting the DynamoDB container, using the option WithDisableTelemetry
.
The following options are exposed by the testcontainers
package.
Basic Options¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Not available until the next release mainWithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Not available until the next release mainWithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Not available until the next release mainWithAdditionalLifecycleHooks
Not available until the next release mainWithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Not available until the next release mainWithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Not available until the next release mainWithImageSubstitutors
Since v0.26.0WithImagePlatform
Not available until the next release main
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Not available until the next release mainWithBridgeNetwork
Not available until the next release mainWithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Not available until the next release mainWithNoStart
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The DynamoDB container exposes the following methods:
ConnectionString¶
- Since v0.34.0
The ConnectionString
method returns the connection string to the DynamoDB container. This connection string can be used to connect to the DynamoDB container from your application,
using the AWS SDK or any other DynamoDB client of your choice.
var errs []error
hostPort, err := c.ConnectionString(context.Background())
if err != nil {
errs = append(errs, fmt.Errorf("get connection string: %w", err))
}
cfg, err := config.LoadDefaultConfig(context.Background(), config.WithCredentialsProvider(credentials.StaticCredentialsProvider{
Value: aws.Credentials{
AccessKeyID: "DUMMYIDEXAMPLE",
SecretAccessKey: "DUMMYEXAMPLEKEY",
},
}))
if err != nil {
errs = append(errs, fmt.Errorf("load default config: %w", err))
}
require.NoError(t, errors.Join(errs...))
return dynamodb.NewFromConfig(cfg, dynamodb.WithEndpointResolverV2(&dynamoDBResolver{HostPort: hostPort}))
The above example uses github.com/aws/aws-sdk-go-v2/service/dynamodb
to create a client and connect to the DynamoDB container.