Aws/kafkaconnect
@swamp/aws/kafkaconnectv2026.10.25.1
01README
AWS KAFKACONNECT infrastructure models
02Behaviors
@swamp/aws/kafkaconnect/connectorv2026.10.23.1connector.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Capacity | object | Information about the capacity allocated to the connector. |
| ConnectorConfiguration | record | The configuration for the connector. |
| ConnectorDescription? | string | A summary description of the connector. |
| ConnectorName | string | The name of the connector. |
| KafkaCluster | object | Details of how to connect to the Kafka cluster. |
| KafkaClusterClientAuthentication | object | Details of the client authentication used by the Kafka cluster. |
| KafkaClusterEncryptionInTransit | object | Details of encryption in transit to the Kafka cluster. |
| KafkaConnectVersion | string | The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins. |
| NetworkType? | enum | The network type of the Connector. |
| LogDelivery? | object | Details of what logs are delivered and where they are delivered. |
| Plugins | array | List of plugins to use with the connector. |
| ServiceExecutionRoleArn | string | The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources. |
| Tags? | array | A collection of tags associated with a resource |
| WorkerConfiguration? | object | Specifies the worker configuration to use with the connector. |
fn create()
Create a KafkaConnect Connector
fn get(identifier: string)
Get a KafkaConnect Connector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the KafkaConnect Connector |
fn update()
Update a KafkaConnect Connector
fn delete(identifier: string)
Delete a KafkaConnect Connector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the KafkaConnect Connector |
fn sync()
Sync KafkaConnect Connector state from AWS
fn list(maxPages?: number, resourceModel?: string)
List KafkaConnect Connector resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— KafkaConnect Connector resource state
@swamp/aws/kafkaconnect/custom-pluginv2026.10.23.1custom_plugin.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the custom plugin. |
| Description? | string | A summary description of the custom plugin. |
| ContentType | enum | The type of the plugin file. |
| FileDescription? | object | Details about the custom plugin file. |
| Location | object | Information about the location of a custom plugin. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a KafkaConnect CustomPlugin
fn get(identifier: string)
Get a KafkaConnect CustomPlugin
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the KafkaConnect CustomPlugin |
fn update()
Update a KafkaConnect CustomPlugin
fn delete(identifier: string)
Delete a KafkaConnect CustomPlugin
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the KafkaConnect CustomPlugin |
fn sync()
Sync KafkaConnect CustomPlugin state from AWS
fn list(maxPages?: number, resourceModel?: string)
List KafkaConnect CustomPlugin resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— KafkaConnect CustomPlugin resource state
@swamp/aws/kafkaconnect/worker-configurationv2026.10.23.1worker_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the worker configuration. |
| Description? | string | A summary description of the worker configuration. |
| PropertiesFileContent | string | Base64 encoded contents of connect-distributed.properties file. |
| Tags? | array | A collection of tags associated with a resource |
fn create()
Create a KafkaConnect WorkerConfiguration
fn get(identifier: string)
Get a KafkaConnect WorkerConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the KafkaConnect WorkerConfiguration |
fn update()
Update a KafkaConnect WorkerConfiguration
fn delete(identifier: string)
Delete a KafkaConnect WorkerConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the KafkaConnect WorkerConfiguration |
fn sync()
Sync KafkaConnect WorkerConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List KafkaConnect WorkerConfiguration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— KafkaConnect WorkerConfiguration resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: connector, custom_plugin, worker_configuration
2026.10.13.1
- Updated: connector, custom_plugin, worker_configuration
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
04Stats
A
100 / 100
Downloads
115
Archive size
623.9 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels