|
| 1 | += aws_dynamodb_cdc |
| 2 | +:type: input |
| 3 | +:status: beta |
| 4 | +:categories: ["Services","AWS"] |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +//// |
| 9 | + THIS FILE IS AUTOGENERATED! |
| 10 | + |
| 11 | + To make changes, edit the corresponding source file under: |
| 12 | + |
| 13 | + https://github.com/redpanda-data/connect/tree/main/internal/impl/<provider>. |
| 14 | + |
| 15 | + And: |
| 16 | + |
| 17 | + https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl |
| 18 | +//// |
| 19 | +
|
| 20 | +// © 2024 Redpanda Data Inc. |
| 21 | +
|
| 22 | +
|
| 23 | +component_type_dropdown::[] |
| 24 | +
|
| 25 | +
|
| 26 | +Reads change data capture (CDC) events from DynamoDB Streams |
| 27 | +
|
| 28 | +Introduced in version 1.0.0. |
| 29 | +
|
| 30 | +
|
| 31 | +[tabs] |
| 32 | +====== |
| 33 | +Common:: |
| 34 | ++ |
| 35 | +-- |
| 36 | +
|
| 37 | +```yml |
| 38 | +# Common config fields, showing default values |
| 39 | +input: |
| 40 | + label: "" |
| 41 | + aws_dynamodb_cdc: |
| 42 | + table: "" # No default (required) |
| 43 | + checkpoint_table: redpanda_dynamodb_checkpoints |
| 44 | + start_from: trim_horizon |
| 45 | +``` |
| 46 | +
|
| 47 | +-- |
| 48 | +Advanced:: |
| 49 | ++ |
| 50 | +-- |
| 51 | +
|
| 52 | +```yml |
| 53 | +# All config fields, showing default values |
| 54 | +input: |
| 55 | + label: "" |
| 56 | + aws_dynamodb_cdc: |
| 57 | + table: "" # No default (required) |
| 58 | + checkpoint_table: redpanda_dynamodb_checkpoints |
| 59 | + batch_size: 1000 |
| 60 | + poll_interval: 1s |
| 61 | + start_from: trim_horizon |
| 62 | + checkpoint_limit: 1000 |
| 63 | + max_tracked_shards: 10000 |
| 64 | + region: "" # No default (optional) |
| 65 | + endpoint: "" # No default (optional) |
| 66 | + tcp: |
| 67 | + connect_timeout: 0s |
| 68 | + keep_alive: |
| 69 | + idle: 15s |
| 70 | + interval: 15s |
| 71 | + count: 9 |
| 72 | + tcp_user_timeout: 0s |
| 73 | + credentials: |
| 74 | + profile: "" # No default (optional) |
| 75 | + id: "" # No default (optional) |
| 76 | + secret: "" # No default (optional) |
| 77 | + token: "" # No default (optional) |
| 78 | + from_ec2_role: false # No default (optional) |
| 79 | + role: "" # No default (optional) |
| 80 | + role_external_id: "" # No default (optional) |
| 81 | +``` |
| 82 | +
|
| 83 | +-- |
| 84 | +====== |
| 85 | +
|
| 86 | +Consumes records from DynamoDB Streams with automatic checkpointing and shard management. |
| 87 | +
|
| 88 | +DynamoDB Streams capture item-level changes in DynamoDB tables. This input supports: |
| 89 | +- Automatic shard discovery and management |
| 90 | +- Checkpoint-based resumption after crashes |
| 91 | +- Multiple shard processing |
| 92 | +
|
| 93 | +For better performance and longer retention, consider using Kinesis Data Streams for DynamoDB |
| 94 | +with the `aws_kinesis` input instead. |
| 95 | +
|
| 96 | +
|
| 97 | +== Fields |
| 98 | +
|
| 99 | +=== `table` |
| 100 | +
|
| 101 | +The name of the DynamoDB table to read streams from. |
| 102 | +
|
| 103 | +
|
| 104 | +*Type*: `string` |
| 105 | +
|
| 106 | +
|
| 107 | +=== `checkpoint_table` |
| 108 | +
|
| 109 | +DynamoDB table name for storing checkpoints. Will be created if it doesn't exist. |
| 110 | +
|
| 111 | +
|
| 112 | +*Type*: `string` |
| 113 | +
|
| 114 | +*Default*: `"redpanda_dynamodb_checkpoints"` |
| 115 | +
|
| 116 | +=== `batch_size` |
| 117 | +
|
| 118 | +Maximum number of records to read in a single batch. |
| 119 | +
|
| 120 | +
|
| 121 | +*Type*: `int` |
| 122 | +
|
| 123 | +*Default*: `1000` |
| 124 | +
|
| 125 | +=== `poll_interval` |
| 126 | +
|
| 127 | +Time to wait between polling attempts when no records are available. |
| 128 | +
|
| 129 | +
|
| 130 | +*Type*: `string` |
| 131 | +
|
| 132 | +*Default*: `"1s"` |
| 133 | +
|
| 134 | +=== `start_from` |
| 135 | +
|
| 136 | +Where to start reading when no checkpoint exists. `trim_horizon` starts from the oldest available record, `latest` starts from new records. |
| 137 | +
|
| 138 | +
|
| 139 | +*Type*: `string` |
| 140 | +
|
| 141 | +*Default*: `"trim_horizon"` |
| 142 | +
|
| 143 | +Options: |
| 144 | +`trim_horizon` |
| 145 | +, `latest` |
| 146 | +. |
| 147 | +
|
| 148 | +=== `checkpoint_limit` |
| 149 | +
|
| 150 | +Maximum number of messages to process before updating checkpoint. |
| 151 | +
|
| 152 | +
|
| 153 | +*Type*: `int` |
| 154 | +
|
| 155 | +*Default*: `1000` |
| 156 | +
|
| 157 | +=== `max_tracked_shards` |
| 158 | +
|
| 159 | +Maximum number of shards to track simultaneously. Prevents memory issues with extremely large tables. |
| 160 | +
|
| 161 | +
|
| 162 | +*Type*: `int` |
| 163 | +
|
| 164 | +*Default*: `10000` |
| 165 | +
|
| 166 | +=== `region` |
| 167 | +
|
| 168 | +The AWS region to target. |
| 169 | +
|
| 170 | +
|
| 171 | +*Type*: `string` |
| 172 | +
|
| 173 | +
|
| 174 | +=== `endpoint` |
| 175 | +
|
| 176 | +Allows you to specify a custom endpoint for the AWS API. |
| 177 | +
|
| 178 | +
|
| 179 | +*Type*: `string` |
| 180 | +
|
| 181 | +
|
| 182 | +=== `tcp` |
| 183 | +
|
| 184 | +TCP socket configuration. |
| 185 | +
|
| 186 | +
|
| 187 | +*Type*: `object` |
| 188 | +
|
| 189 | +
|
| 190 | +=== `tcp.connect_timeout` |
| 191 | +
|
| 192 | +Maximum amount of time a dial will wait for a connect to complete. Zero disables. |
| 193 | +
|
| 194 | +
|
| 195 | +*Type*: `string` |
| 196 | +
|
| 197 | +*Default*: `"0s"` |
| 198 | +
|
| 199 | +=== `tcp.keep_alive` |
| 200 | +
|
| 201 | +TCP keep-alive probe configuration. |
| 202 | +
|
| 203 | +
|
| 204 | +*Type*: `object` |
| 205 | +
|
| 206 | +
|
| 207 | +=== `tcp.keep_alive.idle` |
| 208 | +
|
| 209 | +Duration the connection must be idle before sending the first keep-alive probe. Zero defaults to 15s. Negative values disable keep-alive probes. |
| 210 | +
|
| 211 | +
|
| 212 | +*Type*: `string` |
| 213 | +
|
| 214 | +*Default*: `"15s"` |
| 215 | +
|
| 216 | +=== `tcp.keep_alive.interval` |
| 217 | +
|
| 218 | +Duration between keep-alive probes. Zero defaults to 15s. |
| 219 | +
|
| 220 | +
|
| 221 | +*Type*: `string` |
| 222 | +
|
| 223 | +*Default*: `"15s"` |
| 224 | +
|
| 225 | +=== `tcp.keep_alive.count` |
| 226 | +
|
| 227 | +Maximum unanswered keep-alive probes before dropping the connection. Zero defaults to 9. |
| 228 | +
|
| 229 | +
|
| 230 | +*Type*: `int` |
| 231 | +
|
| 232 | +*Default*: `9` |
| 233 | +
|
| 234 | +=== `tcp.tcp_user_timeout` |
| 235 | +
|
| 236 | +Maximum time to wait for acknowledgment of transmitted data before killing the connection. Linux-only (kernel 2.6.37+), ignored on other platforms. When enabled, keep_alive.idle must be greater than this value per RFC 5482. Zero disables. |
| 237 | +
|
| 238 | +
|
| 239 | +*Type*: `string` |
| 240 | +
|
| 241 | +*Default*: `"0s"` |
| 242 | +
|
| 243 | +=== `credentials` |
| 244 | +
|
| 245 | +Optional manual configuration of AWS credentials to use. More information can be found in xref:guides:cloud/aws.adoc[]. |
| 246 | +
|
| 247 | +
|
| 248 | +*Type*: `object` |
| 249 | +
|
| 250 | +
|
| 251 | +=== `credentials.profile` |
| 252 | +
|
| 253 | +A profile from `~/.aws/credentials` to use. |
| 254 | +
|
| 255 | +
|
| 256 | +*Type*: `string` |
| 257 | +
|
| 258 | +
|
| 259 | +=== `credentials.id` |
| 260 | +
|
| 261 | +The ID of credentials to use. |
| 262 | +
|
| 263 | +
|
| 264 | +*Type*: `string` |
| 265 | +
|
| 266 | +
|
| 267 | +=== `credentials.secret` |
| 268 | +
|
| 269 | +The secret for the credentials being used. |
| 270 | +[CAUTION] |
| 271 | +==== |
| 272 | +This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info]. |
| 273 | +==== |
| 274 | +
|
| 275 | +
|
| 276 | +
|
| 277 | +*Type*: `string` |
| 278 | +
|
| 279 | +
|
| 280 | +=== `credentials.token` |
| 281 | +
|
| 282 | +The token for the credentials being used, required when using short term credentials. |
| 283 | +
|
| 284 | +
|
| 285 | +*Type*: `string` |
| 286 | +
|
| 287 | +
|
| 288 | +=== `credentials.from_ec2_role` |
| 289 | +
|
| 290 | +Use the credentials of a host EC2 machine configured to assume https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html[an IAM role associated with the instance^]. |
| 291 | +
|
| 292 | +
|
| 293 | +*Type*: `bool` |
| 294 | +
|
| 295 | +Requires version 4.2.0 or newer |
| 296 | +
|
| 297 | +=== `credentials.role` |
| 298 | +
|
| 299 | +A role ARN to assume. |
| 300 | +
|
| 301 | +
|
| 302 | +*Type*: `string` |
| 303 | +
|
| 304 | +
|
| 305 | +=== `credentials.role_external_id` |
| 306 | +
|
| 307 | +An external ID to provide when assuming a role. |
| 308 | +
|
| 309 | +
|
| 310 | +*Type*: `string` |
| 311 | +
|
| 312 | +
|
| 313 | +```yml |
| 314 | +# Examples |
| 315 | +
|
| 316 | +input: |
| 317 | + aws_dynamodb_cdc: |
| 318 | + table: my_table |
| 319 | + region: us-east-1 |
| 320 | + credentials: |
| 321 | + role: arn:aws:iam::123456789012:role/DynamoDBStreamReader |
| 322 | + role_external_id: "unique-external-id-12345" |
| 323 | +``` |
0 commit comments