> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.polytomic.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# Amazon Keyspaces

Supports:
* ✅ Models
* ✅ Bulk sync source


## Connection

### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>auth_method</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Authentication method<br/><br/>Accepted values: `access_key_and_secret` <a href="#auth-method-access-key-and-secret">↓</a>, `iam_role` <a href="#auth-method-iam-role">↓</a>, `service_credentials` <a href="#auth-method-service-credentials">↓</a></td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>region</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">AWS region</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

<a id="auth-method-access-key-and-secret"></a>

#### `auth_method` = `access_key_and_secret`

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>access_key_id</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">AWS access key ID</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>secret_access_key</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">AWS secret access key</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Amazon Keyspaces connection",
  "type": "amazon_keyspaces",
  "configuration": {
    "access_key_id": "your-access-key-id",
    "auth_method": "access_key_and_secret",
    "region": "us-east-1",
    "secret_access_key": "your-secret-access-key"
  }
}
```

<a id="auth-method-iam-role"></a>

#### `auth_method` = `iam_role`

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>iam_role_arn</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">IAM role ARN</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

<table>
<thead>
<tr>
<th>Read-only property</th><th>Type</th><th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>external_id</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">External ID for the IAM role</td>
</tr>
</tbody>
</table>

```json
{
  "name": "Amazon Keyspaces connection",
  "type": "amazon_keyspaces",
  "configuration": {
    "auth_method": "iam_role",
    "iam_role_arn": "",
    "region": "us-east-1"
  }
}
```

<a id="auth-method-service-credentials"></a>

#### `auth_method` = `service_credentials`

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>password</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Password</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>username</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Username</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Amazon Keyspaces connection",
  "type": "amazon_keyspaces",
  "configuration": {
    "auth_method": "service_credentials",
    "password": "",
    "region": "us-east-1",
    "username": "your-service-username"
  }
}
```

<a id="auth-method-access-key-and-secret|iam-role"></a>

#### `auth_method` = `access_key_and_secret|iam_role`

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>change_detection</code></td>
<td><code>boolean</code></td>
<td style="vertical-align: top;">Use Amazon Keyspaces CDC streams for bulk syncs <a href="#change-detection-true">↓</a></td>
<td><code>optional</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Amazon Keyspaces connection",
  "type": "amazon_keyspaces",
  "configuration": {
    "auth_method": "access_key_and_secret|iam_role",
    "change_detection": false,
    "region": "us-east-1"
  }
}
```

<a id="change-detection-true"></a>

##### `change_detection`

When `change_detection` is `true`:

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>managed_streams</code></td>
<td><code>boolean</code></td>
<td style="vertical-align: top;">Let Polytomic manage Amazon Keyspaces CDC stream settings</td>
<td><code>optional</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Amazon Keyspaces connection",
  "type": "amazon_keyspaces",
  "configuration": {
    "auth_method": "access_key_and_secret|iam_role",
    "change_detection": true,
    "managed_streams": false,
    "region": "us-east-1"
  }
}
```



## Model Sync
### Source
#### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>keyspace</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Keyspace</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>table</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Table</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>


#### Example
```json
{
  ...
  "configuration": {
    "keyspace": "app",
    "table": "users"
  }
}
```







## Bulk Sync
### Source
Amazon Keyspaces connections may be used as a bulk sync source. No additional configuration options are required.