# Configuration Reference for Amazon DynamoDB Sink Connector for Confluent Platform To use this connector, specify the name of the connector class in the `connector.class` configuration property. ```properties connector.class=io.confluent.connect.aws.dynamodb.DynamoDbSinkConnector ``` Connector-specific configuration properties are described below. #### NOTE These are properties for the self-managed connector. If you are using Confluent Cloud, see [Amazon DynamoDB Sink Connector for Confluent Cloud](/cloud/current/connectors/cc-amazon-dynamo-db-sink.html). ## DynamoDB Parameters `aws.dynamodb.max.retry.time.seconds` : The maximum time up to which the DynamoDB client will try writing records.
* Type: long * Default: 5 * Importance: low `aws.dynamodb.pk.hash` : Defines how the table’s hash key is extracted from the records. By default, partition is used as the hash key. The maximum size of a partition with this configuration is 10 GB as defined by DynamoDB limits.
This hash key reference is created from a record reference and optional alias name. If the alias name is absent, then the last field of the reference is used as the column name.
The following are valid record references:
1. `partition` - refers to the Kafka partition number where the record is originated 2. `offset` - refers to the Kafka offset of the record 3. `key.[fieldNameOrDotDelimitedPath]` - to use the record’s key itself or one of the fields from the record key 4. `value.[fieldNameOrDotDelimitedPath]` - to use the record’s value itself or one of the fields from the record’s value
Valid examples:
1. partition - A field `partition` as hash key 2. key - Key of the record as a hash key 3. key.customerId - When message key is a Struct use customerId as the field 4. value.userId:user - Uses a hash field `user`
* Type: string * Default: partition * Valid Values: Matches regex `^(?partition|offset|key(\.[a-zA-Z1-9\_\-\.]{1,255})*|value(\.[a-zA-Z1-9\_\-\.]{1,255})*){1}(:(?[a-zA-Z1-9\_\-\.]{1,255}))?$` * Importance: high
For more help with using this parameter, see [Use aws.dynamodb.pk.hash and aws.dynamodb.pk.sort](overview.md#dynamodb-using-pk-hash-and-pk-sort-parameters). `aws.dynamodb.pk.sort` : Defines how the table’s sort key is extracted from the records. By default, it uses the record offset as sort key. This sort key reference is created from a record reference and optional alias name. If the alias name is absent, then the last field of the reference is used as the column name.
If no sort key is required, configure this property to be an empty string. The following are valid record references:
1. `partition` - refers to the Kafka partition number where the record is originated 2. `offset` - refers to the Kafka offset of the record 3. `key.[fieldNameOrDotDelimitedPath]` - to use the record’s key itself or one of the fields from the record key 4. `value.[fieldNameOrDotDelimitedPath]` - to use the record’s value itself or one of the fields from the record’s value
Valid examples:
1. partition - A field `partition` as sort key 2. key - Key of the record as a sort key 3. key.customerId - When message key is a Struct use customerId as the field 4. value.userId:user - Uses a sort field `user`
* Type: string * Default: offset * Valid Values: either Matches regex `^(?partition|offset|key(\.[a-zA-Z1-9\_\-\.]{1,255})*|value(\.[a-zA-Z1-9\_\-\.]{1,255})*){1}(:(?[a-zA-Z1-9\_\-\.]{1,255}))?$`, or one of [] * Importance: high
For more help with using this parameter, see [Use aws.dynamodb.pk.hash and aws.dynamodb.pk.sort](overview.md#dynamodb-using-pk-hash-and-pk-sort-parameters). `aws.dynamodb.proxy.user` : DynamoDB Proxy User.
* Type: string * Default: null * Importance: low `aws.dynamodb.credentials.provider.class` : Credentials provider or provider chain to use for authentication to AWS. By default the connector uses `DefaultAWSCredentialsProviderChain`.
* Type: class * Default: com.amazonaws.auth.DefaultAWSCredentialsProviderChain * Valid Values: Any class implementing: interface com.amazonaws.auth.AWSCredentialsProvider * Importance: low `aws.dynamodb.credentials.provider.sts.role.arn` : Role ARN to use when starting a session under an assumed role.
* Type: string * Default: null * Importance: high `aws.dynamodb.credentials.provider.sts.role.external.id` : The role external ID used when retrieving session credentials under an assumed role.
* Type: string * Default: null * Importance: medium `aws.dynamodb.credentials.provider.sts.role.session.name` : Role session name to use when starting a session under an assumed role.
* Type: string * Default: null * Importance: high `aws.dynamodb.endpoint` : Overwrite endpoint configuration and AWS service discovery for DynamoDB.
* Type: string * Default: null * Importance: low `aws.dynamodb.region` : The AWS region to be used by the connector.
* Type: string * Default: us-west-2 * Valid Values: one of [ap-south-1, eu-north-1, eu-west-3, eu-west-2, eu-west-1, ap-northeast-2, us-gov-east-1, ap-northeast-1, ca-central-1, sa-east-1, ap-east-1, cn-north-1, us-gov-west-1, ap-southeast-1, ap-southeast-2, eu-central-1, us-east-1, us-east-2, us-west-1, cn-northwest-1, us-west-2] * Importance: medium `table.name.format` : A format string for the destination table name, which may contain ‘${topic}’ as a placeholder for the originating topic name.
For example, `kafka_${topic}` for the topic ‘orders’ will map to the table name ‘kafka_orders’.
* Type: string * Default: ${topic} * Importance: medium ## Proxy Connection Parameters `aws.dynamodb.proxy.url` : DynamoDB Proxy URL. For example [http://proxy.example.com:8080](http://proxy.example.com:8080), [https://user:pass@proxy.example.com:8443](https://user:pass@proxy.example.com:8443)
* Type: string * Default: “” * Importance: low `aws.dynamodb.proxy.password` : DynamoDB Proxy Password.
* Type: password * Default: null * Importance: low ## CSFLE and CSPE configurations `csfle.enabled` Accepts a boolean value. CSFLE is enabled for the connector if `csfle.enabled` is set to True. * Type: boolean * Default: False `auto.register.schemas` Specifies if the Serializer should attempt to register the Schema with Schema Registry. * Type: boolean * Default: true * Importance: medium `use.latest.version` Only applies when `auto.register.schemas` is set to false. If `auto.register.schemas` is set to false and `use.latest.version` is set to true, then instead of deriving a schema for the object passed to the client for serialization, Schema Registry uses the latest version of the schema in the subject for serialization. * Type: boolean * Default: true * Importance: medium ## Confluent Platform license `confluent.topic.bootstrap.servers` : A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the following form:
```text host1:port1,host2:port2... ```
Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).
* Type: list * Importance: high `confluent.topic` : Name of the Kafka topic used for Confluent Platform configuration, including licensing information.
* Type: string * Default: \_confluent-command * Importance: low `confluent.topic.replication.factor` : The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).
* Type: int * Default: 3 * Importance: low ### Confluent license properties You can put license-related properties in the connector configuration, or in license-related properties in the [Connect worker configuration](https://docs.confluent.io/kafka-connectors/self-managed/license.html#centralized-license-in-the-kconnect-long-worker) instead of in each connector configuration. This connector is proprietary and requires a license. The license information is stored in the `_confluent-command` topic. If the broker requires SSL for connections, you must include the security-related `confluent.topic.*` properties as described below. `confluent.license` : Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for `confluent.license`. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.
If you are a subscriber, contact Confluent Support for more information.
* Type: string * Default: “” * Valid Values: Confluent Platform license * Importance: high `confluent.topic.ssl.truststore.location` : The location of the trust store file.
* Type: string * Default: null * Importance: high `confluent.topic.ssl.truststore.password` : The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.
* Type: password * Default: null * Importance: high `confluent.topic.ssl.keystore.location` : The location of the key store file. This is optional for client and can be used for two-way authentication for client.
* Type: string * Default: null * Importance: high `confluent.topic.ssl.keystore.password` : The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.
* Type: password * Default: null * Importance: high `confluent.topic.ssl.key.password` : The password of the private key in the key store file. This is optional for client.
* Type: password * Default: null * Importance: high `confluent.topic.security.protocol` : Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
* Type: string * Default: “PLAINTEXT” * Importance: medium ### License topic configuration A Confluent enterprise license is stored in the `_confluent-command` topic. This topic is created by default and contains the license that corresponds to the license key supplied through the `confluent.license` property. No public keys are stored in Kafka topics. The following describes how the default `_confluent-command` topic is generated under different scenarios: * A 30-day trial license is automatically generated for the `_confluent-command` topic if you do not add the `confluent.license` property or leave this property empty (for example, `confluent.license=`). * Adding a valid license key (for example, `confluent.license=`) adds a valid license in the `_confluent-command` topic. Here is an example of the minimal properties for development and testing. You can change the name of the `_confluent-command` topic using the `confluent.topic` property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server. ```none confluent.topic=foo_confluent-command confluent.topic.bootstrap.servers=localhost:9092 ``` The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with `confluent.topic.`. ### License topic ACLs The `_confluent-command` topic contains the license that corresponds to the license key supplied through the `confluent.license` property. It is created by default. Connectors that access this topic require the following ACLs configured: * CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic. * DESCRIBE, READ, and WRITE on the `_confluent-command` topic. #### IMPORTANT You can also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic. You can provide access either individually for each principal that will use the license or use a [wildcard entry](/platform/current/kafka/authorization.html#acl-wildcard-principals) to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and `_confluent-command` topic. 1. Set a CREATE and DESCRIBE ACL on the resource cluster: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation CREATE --operation DESCRIBE --cluster ``` 2. Set a DESCRIBE, READ, and WRITE ACL on the `_confluent-command` topic: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command ``` ### Override Default Configuration Properties You can override the replication factor using `confluent.topic.replication.factor`. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the `confluent.topic.replication.factor` property to `1`. You can override producer-specific properties by using the `producer.override.*` prefix (for source connectors) and consumer-specific properties by using the `consumer.override.*` prefix (for sink connectors). You can use the defaults or customize the other properties as well. For example, the `confluent.topic.client.id` property defaults to the name of the connector with `-licensing` suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix. You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.