|
| 1 | +version: "1.0" |
| 2 | +specification: |
| 3 | + name: dynamodb |
| 4 | + summary: A DynamoDB source plugin for Conduit |
| 5 | + description: | |
| 6 | + ## Source |
| 7 | + A source connector that pulls data from a DynamoDB table to downstream resources via Conduit. |
| 8 | +
|
| 9 | + The connector starts with a snapshot of the data currently existent in the table, sends these records to the |
| 10 | + destination, then starts the CDC (Change Data Capture) mode which will listen to events happening on the table |
| 11 | + in real-time, and sends these events' records to the destination (these events include: `updates`, `deletes`, and `inserts`). |
| 12 | + You can opt out from taking the snapshot by setting the parameter `skipSnapshot` to `true`, meaning that only the CDC |
| 13 | + events will be captured. |
| 14 | +
|
| 15 | + The source connector uses [DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) to get CDC events, |
| 16 | + so you need to enable the stream before running the connector. Check out the documentation for [how to enable a DynamoDB Stream](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html#Streams.Enabling). |
| 17 | +
|
| 18 | + ## Destination |
| 19 | + A destination connector that takes a conduit record and stores it into a DynamoDB table. |
| 20 | +
|
| 21 | + The Destination is designed to handle different kinds of operations, based on the `Operation` field in the record |
| 22 | + received, the destination will either `insert`, `update` or `delete` the record in the target table. Snapshot records |
| 23 | + are always inserted. |
| 24 | +
|
| 25 | + > **Note:** Make sure to create the destination table before running the pipeline, the table needs to have the same |
| 26 | + schema as the records that will be sent into it, either from the source, or from a processor. |
| 27 | + version: v0.4.0 |
| 28 | + author: Meroxa, Inc. |
| 29 | + source: |
| 30 | + parameters: |
| 31 | + - name: aws.region |
| 32 | + description: AWS region. |
| 33 | + type: string |
| 34 | + default: "" |
| 35 | + validations: |
| 36 | + - type: required |
| 37 | + value: "" |
| 38 | + - name: table |
| 39 | + description: Table is the DynamoDB table name to pull data from, or push data into. |
| 40 | + type: string |
| 41 | + default: "" |
| 42 | + validations: |
| 43 | + - type: required |
| 44 | + value: "" |
| 45 | + - name: aws.accessKeyId |
| 46 | + description: |- |
| 47 | + AWS access key id. Optional - if not provided, the connector will use the default credential chain |
| 48 | + (environment variables, shared credentials file, or IAM role). For production environments, |
| 49 | + it's recommended to use the default credential chain with IAM roles rather than static credentials. |
| 50 | + type: string |
| 51 | + default: "" |
| 52 | + validations: [] |
| 53 | + - name: aws.assumeRoleArn |
| 54 | + description: AWS AssumeRoleChain. Optional - if not provided, the connector will use the default credential chain. |
| 55 | + type: string |
| 56 | + default: "" |
| 57 | + validations: [] |
| 58 | + - name: aws.secretAccessKey |
| 59 | + description: |- |
| 60 | + AWS secret access key. Optional - if not provided, the connector will use the default credential chain |
| 61 | + (environment variables, shared credentials file, or IAM role). For production environments, |
| 62 | + it's recommended to use the default credential chain with IAM roles rather than static credentials. |
| 63 | + type: string |
| 64 | + default: "" |
| 65 | + validations: [] |
| 66 | + - name: aws.sessionToken |
| 67 | + description: |- |
| 68 | + AWS temporary session token. Optional - if not provided, the connector will use the default credential chain. |
| 69 | + Note that to keep the connector running long-term, you should use the default credential chain |
| 70 | + rather than temporary session tokens which will expire. For production environments, |
| 71 | + it's recommended to use IAM roles (IRSA, EC2 instance profile, or ECS task role). |
| 72 | + type: string |
| 73 | + default: "" |
| 74 | + validations: [] |
| 75 | + - name: aws.url |
| 76 | + description: The URL for AWS (useful when testing the connector with localstack). |
| 77 | + type: string |
| 78 | + default: "" |
| 79 | + validations: [] |
| 80 | + - name: discoveryPollingPeriod |
| 81 | + description: 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. |
| 82 | + type: duration |
| 83 | + default: 10s |
| 84 | + validations: [] |
| 85 | + - name: recordsPollingPeriod |
| 86 | + description: Records polling period for the CDC mode of how often to get new records from a shard, formatted as a time.Duration string. |
| 87 | + type: duration |
| 88 | + default: 1s |
| 89 | + validations: [] |
| 90 | + - name: skipSnapshot |
| 91 | + description: SkipSnapshot determines weather to skip the snapshot or not. |
| 92 | + type: bool |
| 93 | + default: "false" |
| 94 | + validations: [] |
| 95 | + - name: sdk.batch.delay |
| 96 | + description: Maximum delay before an incomplete batch is read from the source. |
| 97 | + type: duration |
| 98 | + default: "0" |
| 99 | + validations: [] |
| 100 | + - name: sdk.batch.size |
| 101 | + description: Maximum size of batch before it gets read from the source. |
| 102 | + type: int |
| 103 | + default: "0" |
| 104 | + validations: |
| 105 | + - type: greater-than |
| 106 | + value: "-1" |
| 107 | + - name: sdk.schema.context.enabled |
| 108 | + description: |- |
| 109 | + Specifies whether to use a schema context name. If set to false, no schema context name will |
| 110 | + be used, and schemas will be saved with the subject name specified in the connector |
| 111 | + (not safe because of name conflicts). |
| 112 | + type: bool |
| 113 | + default: "true" |
| 114 | + validations: [] |
| 115 | + - name: sdk.schema.context.name |
| 116 | + description: |- |
| 117 | + Schema context name to be used. Used as a prefix for all schema subject names. |
| 118 | + If empty, defaults to the connector ID. |
| 119 | + type: string |
| 120 | + default: "" |
| 121 | + validations: [] |
| 122 | + - name: sdk.schema.extract.key.enabled |
| 123 | + description: Whether to extract and encode the record key with a schema. |
| 124 | + type: bool |
| 125 | + default: "true" |
| 126 | + validations: [] |
| 127 | + - name: sdk.schema.extract.key.subject |
| 128 | + description: |- |
| 129 | + The subject of the key schema. If the record metadata contains the field |
| 130 | + "opencdc.collection" it is prepended to the subject name and separated |
| 131 | + with a dot. |
| 132 | + type: string |
| 133 | + default: key |
| 134 | + validations: [] |
| 135 | + - name: sdk.schema.extract.payload.enabled |
| 136 | + description: Whether to extract and encode the record payload with a schema. |
| 137 | + type: bool |
| 138 | + default: "true" |
| 139 | + validations: [] |
| 140 | + - name: sdk.schema.extract.payload.subject |
| 141 | + description: |- |
| 142 | + The subject of the payload schema. If the record metadata contains the |
| 143 | + field "opencdc.collection" it is prepended to the subject name and |
| 144 | + separated with a dot. |
| 145 | + type: string |
| 146 | + default: payload |
| 147 | + validations: [] |
| 148 | + - name: sdk.schema.extract.type |
| 149 | + description: The type of the payload schema. |
| 150 | + type: string |
| 151 | + default: avro |
| 152 | + validations: |
| 153 | + - type: inclusion |
| 154 | + value: avro |
| 155 | + destination: |
| 156 | + parameters: |
| 157 | + - name: aws.region |
| 158 | + description: AWS region. |
| 159 | + type: string |
| 160 | + default: "" |
| 161 | + validations: |
| 162 | + - type: required |
| 163 | + value: "" |
| 164 | + - name: table |
| 165 | + description: Table is the DynamoDB table name to pull data from, or push data into. |
| 166 | + type: string |
| 167 | + default: "" |
| 168 | + validations: |
| 169 | + - type: required |
| 170 | + value: "" |
| 171 | + - name: aws.accessKeyId |
| 172 | + description: |- |
| 173 | + AWS access key id. Optional - if not provided, the connector will use the default credential chain |
| 174 | + (environment variables, shared credentials file, or IAM role). For production environments, |
| 175 | + it's recommended to use the default credential chain with IAM roles rather than static credentials. |
| 176 | + type: string |
| 177 | + default: "" |
| 178 | + validations: [] |
| 179 | + - name: aws.assumeRoleArn |
| 180 | + description: AWS AssumeRoleChain. Optional - if not provided, the connector will use the default credential chain. |
| 181 | + type: string |
| 182 | + default: "" |
| 183 | + validations: [] |
| 184 | + - name: aws.secretAccessKey |
| 185 | + description: |- |
| 186 | + AWS secret access key. Optional - if not provided, the connector will use the default credential chain |
| 187 | + (environment variables, shared credentials file, or IAM role). For production environments, |
| 188 | + it's recommended to use the default credential chain with IAM roles rather than static credentials. |
| 189 | + type: string |
| 190 | + default: "" |
| 191 | + validations: [] |
| 192 | + - name: aws.sessionToken |
| 193 | + description: |- |
| 194 | + AWS temporary session token. Optional - if not provided, the connector will use the default credential chain. |
| 195 | + Note that to keep the connector running long-term, you should use the default credential chain |
| 196 | + rather than temporary session tokens which will expire. For production environments, |
| 197 | + it's recommended to use IAM roles (IRSA, EC2 instance profile, or ECS task role). |
| 198 | + type: string |
| 199 | + default: "" |
| 200 | + validations: [] |
| 201 | + - name: aws.url |
| 202 | + description: The URL for AWS (useful when testing the connector with localstack). |
| 203 | + type: string |
| 204 | + default: "" |
| 205 | + validations: [] |
| 206 | + - name: sdk.batch.delay |
| 207 | + description: Maximum delay before an incomplete batch is written to the destination. |
| 208 | + type: duration |
| 209 | + default: "0" |
| 210 | + validations: [] |
| 211 | + - name: sdk.batch.size |
| 212 | + description: Maximum size of batch before it gets written to the destination. |
| 213 | + type: int |
| 214 | + default: "0" |
| 215 | + validations: |
| 216 | + - type: greater-than |
| 217 | + value: "-1" |
| 218 | + - name: sdk.rate.burst |
| 219 | + description: |- |
| 220 | + Allow bursts of at most X records (0 or less means that bursts are not |
| 221 | + limited). Only takes effect if a rate limit per second is set. Note that |
| 222 | + if `sdk.batch.size` is bigger than `sdk.rate.burst`, the effective batch |
| 223 | + size will be equal to `sdk.rate.burst`. |
| 224 | + type: int |
| 225 | + default: "0" |
| 226 | + validations: |
| 227 | + - type: greater-than |
| 228 | + value: "-1" |
| 229 | + - name: sdk.rate.perSecond |
| 230 | + description: Maximum number of records written per second (0 means no rate limit). |
| 231 | + type: float |
| 232 | + default: "0" |
| 233 | + validations: |
| 234 | + - type: greater-than |
| 235 | + value: "-1" |
| 236 | + - name: sdk.record.format |
| 237 | + description: |- |
| 238 | + The format of the output record. See the Conduit documentation for a full |
| 239 | + list of supported formats (https://conduit.io/docs/using/connectors/configuration-parameters/output-format). |
| 240 | + type: string |
| 241 | + default: opencdc/json |
| 242 | + validations: [] |
| 243 | + - name: sdk.record.format.options |
| 244 | + description: |- |
| 245 | + Options to configure the chosen output record format. Options are normally |
| 246 | + key=value pairs separated with comma (e.g. opt1=val2,opt2=val2), except |
| 247 | + for the `template` record format, where options are a Go template. |
| 248 | + type: string |
| 249 | + default: "" |
| 250 | + validations: [] |
| 251 | + - name: sdk.schema.extract.key.enabled |
| 252 | + description: Whether to extract and decode the record key with a schema. |
| 253 | + type: bool |
| 254 | + default: "true" |
| 255 | + validations: [] |
| 256 | + - name: sdk.schema.extract.payload.enabled |
| 257 | + description: Whether to extract and decode the record payload with a schema. |
| 258 | + type: bool |
| 259 | + default: "true" |
| 260 | + validations: [] |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments