Skip to main content

Aws/kafkaconnect

@swamp/aws/kafkaconnectv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS
01README

AWS KAFKACONNECT infrastructure models

02Behaviors3
@swamp/aws/kafkaconnect/connectorv2026.10.23.1connector.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
CapacityobjectInformation about the capacity allocated to the connector.
ConnectorConfigurationrecordThe configuration for the connector.
ConnectorDescription?stringA summary description of the connector.
ConnectorNamestringThe name of the connector.
KafkaClusterobjectDetails of how to connect to the Kafka cluster.
KafkaClusterClientAuthenticationobjectDetails of the client authentication used by the Kafka cluster.
KafkaClusterEncryptionInTransitobjectDetails of encryption in transit to the Kafka cluster.
KafkaConnectVersionstringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
NetworkType?enumThe network type of the Connector.
LogDelivery?objectDetails of what logs are delivered and where they are delivered.
PluginsarrayList of plugins to use with the connector.
ServiceExecutionRoleArnstringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
Tags?arrayA collection of tags associated with a resource
WorkerConfiguration?objectSpecifies the worker configuration to use with the connector.
fn create()
Create a KafkaConnect Connector
fn get(identifier: string)
Get a KafkaConnect Connector
ArgumentTypeDescription
identifierstringThe primary identifier of the KafkaConnect Connector
fn update()
Update a KafkaConnect Connector
fn delete(identifier: string)
Delete a KafkaConnect Connector
ArgumentTypeDescription
identifierstringThe primary identifier of the KafkaConnect Connector
fn sync()
Sync KafkaConnect Connector state from AWS
fn list(maxPages?: number, resourceModel?: string)
List KafkaConnect Connector resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON 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

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
NamestringThe name of the custom plugin.
Description?stringA summary description of the custom plugin.
ContentTypeenumThe type of the plugin file.
FileDescription?objectDetails about the custom plugin file.
LocationobjectInformation about the location of a custom plugin.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a KafkaConnect CustomPlugin
fn get(identifier: string)
Get a KafkaConnect CustomPlugin
ArgumentTypeDescription
identifierstringThe primary identifier of the KafkaConnect CustomPlugin
fn update()
Update a KafkaConnect CustomPlugin
fn delete(identifier: string)
Delete a KafkaConnect CustomPlugin
ArgumentTypeDescription
identifierstringThe primary identifier of the KafkaConnect CustomPlugin
fn sync()
Sync KafkaConnect CustomPlugin state from AWS
fn list(maxPages?: number, resourceModel?: string)
List KafkaConnect CustomPlugin resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON 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

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
NamestringThe name of the worker configuration.
Description?stringA summary description of the worker configuration.
PropertiesFileContentstringBase64 encoded contents of connect-distributed.properties file.
Tags?arrayA collection of tags associated with a resource
fn create()
Create a KafkaConnect WorkerConfiguration
fn get(identifier: string)
Get a KafkaConnect WorkerConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the KafkaConnect WorkerConfiguration
fn update()
Update a KafkaConnect WorkerConfiguration
fn delete(identifier: string)
Delete a KafkaConnect WorkerConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the KafkaConnect WorkerConfiguration
fn sync()
Sync KafkaConnect WorkerConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List KafkaConnect WorkerConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— KafkaConnect WorkerConfiguration resource state
03Previous Versions19
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