A DynamoDB connector for Conduit, It provides both, a source and a destination DynamoDB connector.
Run make build to build the connector.
Run make test-integration to run all the integration tests. Tests require Docker to be installed and running.
The command will handle starting and stopping docker containers for you.
If you want to run the integration tests against your AWS DynamoDB instead of docker, You must set the environment
variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION) before running make test,
or before running the tests manually.
A source connector that pulls data from a DynamoDB table to downstream resources via Conduit.
The connector starts with a snapshot of the data currently existent in the table, sends these records to the
destination, then starts the CDC (Change Data Capture) mode which will listen to events happening on the table
in real-time, and sends these events' records to the destination (these events include: updates, deletes, and inserts).
You can opt out from taking the snapshot by setting the parameter skipSnapshot to true, meaning that only the CDC
events will be captured.
The source connector uses DynamoDB Streams to get CDC events, so you need to enable the stream before running the connector. Check out the documentation for how to enable a DynamoDB Stream.
A destination connector that takes a conduit record and stores it into a DynamoDB table.
The Destination is designed to handle different kinds of operations, based on the Operation field in the record
received, the destination will either insert, update or delete the record in the target table. Snapshot records
are always inserted.
Note: Make sure to create the destination table before running the pipeline, the table needs to have the same schema as the records that will be sent into it, either from the source, or from a processor.
version: 2.2
pipelines:
- id: example
status: running
connectors:
- id: example
plugin: "dynamodb"
settings:
# AWS region.
# Type: string
# Required: yes
aws.region: ""
# Table is the DynamoDB table name to pull data from, or push data
# into.
# Type: string
# Required: yes
table: ""
# AWS access key id. Optional - if not provided, the connector will
# use the default credential chain (environment variables, shared
# credentials file, or IAM role). For production environments, it's
# recommended to use the default credential chain with IAM roles
# rather than static credentials.
# Type: string
# Required: no
aws.accessKeyId: ""
# AWS AssumeRoleChain. Optional - if not provided, the connector will
# use the default credential chain.
# Type: string
# Required: no
aws.assumeRoleArn: ""
# AWS secret access key. Optional - if not provided, the connector
# will use the default credential chain (environment variables, shared
# credentials file, or IAM role). For production environments, it's
# recommended to use the default credential chain with IAM roles
# rather than static credentials.
# Type: string
# Required: no
aws.secretAccessKey: ""
# AWS temporary session token. Optional - if not provided, the
# connector will use the default credential chain. Note that to keep
# the connector running long-term, you should use the default
# credential chain rather than temporary session tokens which will
# expire. For production environments, it's recommended to use IAM
# roles (IRSA, EC2 instance profile, or ECS task role).
# Type: string
# Required: no
aws.sessionToken: ""
# The URL for AWS (useful when testing the connector with localstack).
# Type: string
# Required: no
aws.url: ""
# Discovery polling period for the CDC mode of how often to check for
# new shards in the DynamoDB Stream, formatted as a time.Duration
# string.
# Type: duration
# Required: no
discoveryPollingPeriod: "10s"
# Records polling period for the CDC mode of how often to get new
# records from a shard, formatted as a time.Duration string.
# Type: duration
# Required: no
recordsPollingPeriod: "1s"
# SkipSnapshot determines weather to skip the snapshot or not.
# Type: bool
# Required: no
skipSnapshot: "false"
# Maximum delay before an incomplete batch is read from the source.
# Type: duration
# Required: no
sdk.batch.delay: "0"
# Maximum size of batch before it gets read from the source.
# Type: int
# Required: no
sdk.batch.size: "0"
# Specifies whether to use a schema context name. If set to false, no
# schema context name will be used, and schemas will be saved with the
# subject name specified in the connector (not safe because of name
# conflicts).
# Type: bool
# Required: no
sdk.schema.context.enabled: "true"
# Schema context name to be used. Used as a prefix for all schema
# subject names. If empty, defaults to the connector ID.
# Type: string
# Required: no
sdk.schema.context.name: ""
# Whether to extract and encode the record key with a schema.
# Type: bool
# Required: no
sdk.schema.extract.key.enabled: "true"
# The subject of the key schema. If the record metadata contains the
# field "opencdc.collection" it is prepended to the subject name and
# separated with a dot.
# Type: string
# Required: no
sdk.schema.extract.key.subject: "key"
# Whether to extract and encode the record payload with a schema.
# Type: bool
# Required: no
sdk.schema.extract.payload.enabled: "true"
# The subject of the payload schema. If the record metadata contains
# the field "opencdc.collection" it is prepended to the subject name
# and separated with a dot.
# Type: string
# Required: no
sdk.schema.extract.payload.subject: "payload"
# The type of the payload schema.
# Type: string
# Required: no
sdk.schema.extract.type: "avro"version: 2.2
pipelines:
- id: example
status: running
connectors:
- id: example
plugin: "dynamodb"
settings:
# AWS region.
# Type: string
# Required: yes
aws.region: ""
# Table is the DynamoDB table name to pull data from, or push data
# into.
# Type: string
# Required: yes
table: ""
# AWS access key id. Optional - if not provided, the connector will
# use the default credential chain (environment variables, shared
# credentials file, or IAM role). For production environments, it's
# recommended to use the default credential chain with IAM roles
# rather than static credentials.
# Type: string
# Required: no
aws.accessKeyId: ""
# AWS AssumeRoleChain. Optional - if not provided, the connector will
# use the default credential chain.
# Type: string
# Required: no
aws.assumeRoleArn: ""
# AWS secret access key. Optional - if not provided, the connector
# will use the default credential chain (environment variables, shared
# credentials file, or IAM role). For production environments, it's
# recommended to use the default credential chain with IAM roles
# rather than static credentials.
# Type: string
# Required: no
aws.secretAccessKey: ""
# AWS temporary session token. Optional - if not provided, the
# connector will use the default credential chain. Note that to keep
# the connector running long-term, you should use the default
# credential chain rather than temporary session tokens which will
# expire. For production environments, it's recommended to use IAM
# roles (IRSA, EC2 instance profile, or ECS task role).
# Type: string
# Required: no
aws.sessionToken: ""
# The URL for AWS (useful when testing the connector with localstack).
# Type: string
# Required: no
aws.url: ""
# Maximum delay before an incomplete batch is written to the
# destination.
# Type: duration
# Required: no
sdk.batch.delay: "0"
# Maximum size of batch before it gets written to the destination.
# Type: int
# Required: no
sdk.batch.size: "0"
# Allow bursts of at most X records (0 or less means that bursts are
# not limited). Only takes effect if a rate limit per second is set.
# Note that if `sdk.batch.size` is bigger than `sdk.rate.burst`, the
# effective batch size will be equal to `sdk.rate.burst`.
# Type: int
# Required: no
sdk.rate.burst: "0"
# Maximum number of records written per second (0 means no rate
# limit).
# Type: float
# Required: no
sdk.rate.perSecond: "0"
# The format of the output record. See the Conduit documentation for a
# full list of supported formats
# (https://conduit.io/docs/using/connectors/configuration-parameters/output-format).
# Type: string
# Required: no
sdk.record.format: "opencdc/json"
# Options to configure the chosen output record format. Options are
# normally key=value pairs separated with comma (e.g.
# opt1=val2,opt2=val2), except for the `template` record format, where
# options are a Go template.
# Type: string
# Required: no
sdk.record.format.options: ""
# Whether to extract and decode the record key with a schema.
# Type: bool
# Required: no
sdk.schema.extract.key.enabled: "true"
# Whether to extract and decode the record payload with a schema.
# Type: bool
# Required: no
sdk.schema.extract.payload.enabled: "true"