Aws/msk
@swamp/aws/mskv2026.10.25.1
01README
AWS MSK infrastructure models
02Release Notes
- Updated: channel, cluster, configuration, replicator
03Behaviors
@swamp/aws/msk/batch-scram-secretv2026.10.23.1batch_scram_secret.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| ClusterArn | string | |
| SecretArnList? | array |
fn create()
Create a MSK BatchScramSecret
fn get(identifier: string)
Get a MSK BatchScramSecret
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK BatchScramSecret |
fn update()
Update a MSK BatchScramSecret
fn delete(identifier: string)
Delete a MSK BatchScramSecret
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK BatchScramSecret |
fn sync()
Sync MSK BatchScramSecret state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK BatchScramSecret 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)— MSK BatchScramSecret resource state
@swamp/aws/msk/channelv2026.10.25.1channel.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. |
| ChannelName | string | Name of the channel |
| ClusterArn? | string | The Amazon Resource Name (ARN) of the cluster |
| TopicConfigurationList | array | Topic configuration |
| EncryptionConfiguration? | object | Encryption configuration |
| IcebergDestinationConfiguration? | object | Iceberg destination configuration |
| S3DestinationConfiguration? | object | S3 destination configuration |
| LoggingInfo? | object | Log configuration details for Channel |
| StateInfo? | object | Includes information about the channel state |
| Tags? | record | Tags attached to the channel |
fn create()
Create a MSK Channel
fn get(identifier: string)
Get a MSK Channel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Channel |
fn update()
Update a MSK Channel
fn delete(identifier: string)
Delete a MSK Channel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Channel |
fn sync()
Sync MSK Channel state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK Channel 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)— MSK Channel resource state
@swamp/aws/msk/clusterv2026.10.25.1cluster.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. |
| BrokerNodeGroupInfo | object | |
| EnhancedMonitoring? | enum | |
| KafkaVersion | string | |
| NumberOfBrokerNodes | number | |
| EncryptionInfo? | object | |
| OpenMonitoring? | object | |
| ClusterName | string | |
| ClientAuthentication? | object | |
| LoggingInfo? | object | |
| Tags? | record | A key-value pair to associate with a resource. |
| ConfigurationInfo? | object | |
| StorageMode? | enum | |
| Rebalancing? | object | |
| ZookeeperAccess? | object |
fn create()
Create a MSK Cluster
fn get(identifier: string)
Get a MSK Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Cluster |
fn update()
Update a MSK Cluster
fn delete(identifier: string)
Delete a MSK Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Cluster |
fn sync()
Sync MSK Cluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK Cluster 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)— MSK Cluster resource state
@swamp/aws/msk/cluster-policyv2026.10.23.1cluster_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| Policy | record | A policy document containing permissions to add to the specified cluster. |
| ClusterArn | string | The arn of the cluster for the resource policy. |
fn create()
Create a MSK ClusterPolicy
fn get(identifier: string)
Get a MSK ClusterPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK ClusterPolicy |
fn update()
Update a MSK ClusterPolicy
fn delete(identifier: string)
Delete a MSK ClusterPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK ClusterPolicy |
fn sync()
Sync MSK ClusterPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK ClusterPolicy 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)— MSK ClusterPolicy resource state
@swamp/aws/msk/configurationv2026.10.25.1configuration.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 | |
| Description? | string | |
| ServerProperties | string | |
| KafkaVersionsList? | array |
fn create()
Create a MSK Configuration
fn get(identifier: string)
Get a MSK Configuration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Configuration |
fn update()
Update a MSK Configuration
fn delete(identifier: string)
Delete a MSK Configuration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Configuration |
fn sync()
Sync MSK Configuration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK Configuration 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)— MSK Configuration resource state
@swamp/aws/msk/replicatorv2026.10.25.1replicator.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. |
| ReplicatorName | string | The name of the replicator. |
| Description? | string | A summary description of the replicator. |
| KafkaClusters | array | Specifies a list of Kafka clusters which are targets of the replicator. |
| ReplicationInfoList | array | A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. |
| ServiceExecutionRoleArn | string | The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. |
| Tags? | array | A collection of tags associated with a resource |
| LogDelivery? | object | Configuration for log delivery for the replicator. |
fn create()
Create a MSK Replicator
fn get(identifier: string)
Get a MSK Replicator
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Replicator |
fn update()
Update a MSK Replicator
fn delete(identifier: string)
Delete a MSK Replicator
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Replicator |
fn sync()
Sync MSK Replicator state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK Replicator 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)— MSK Replicator resource state
@swamp/aws/msk/serverless-clusterv2026.10.23.1serverless_cluster.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. |
| ClusterName | string | |
| VpcConfigs | array | |
| ClientAuthentication | object | |
| Tags? | record | A key-value pair to associate with a resource. |
fn create()
Create a MSK ServerlessCluster
fn get(identifier: string)
Get a MSK ServerlessCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK ServerlessCluster |
fn delete(identifier: string)
Delete a MSK ServerlessCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK ServerlessCluster |
fn sync()
Sync MSK ServerlessCluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK ServerlessCluster 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)— MSK ServerlessCluster resource state
@swamp/aws/msk/topicv2026.10.23.1topic.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. |
| ClusterArn | string | The Amazon Resource Name (ARN) of the MSK cluster |
| TopicName | string | The name of the topic |
| PartitionCount | number | The number of partitions for the topic |
| ReplicationFactor | number | The replication factor for the topic |
| Configs? | string | Base64 encoded configuration properties of the topic |
fn create()
Create a MSK Topic
fn get(identifier: string)
Get a MSK Topic
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Topic |
fn update()
Update a MSK Topic
fn delete(identifier: string)
Delete a MSK Topic
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK Topic |
fn sync()
Sync MSK Topic state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK Topic 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)— MSK Topic resource state
@swamp/aws/msk/vpc-connectionv2026.10.23.1vpc_connection.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. |
| Authentication | enum | The type of private link authentication |
| ClientSubnets | array | |
| TargetClusterArn | string | The Amazon Resource Name (ARN) of the target cluster |
| SecurityGroups | array | |
| Tags? | record | A key-value pair to associate with a resource. |
| VpcId | string |
fn create()
Create a MSK VpcConnection
fn get(identifier: string)
Get a MSK VpcConnection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK VpcConnection |
fn update()
Update a MSK VpcConnection
fn delete(identifier: string)
Delete a MSK VpcConnection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MSK VpcConnection |
fn sync()
Sync MSK VpcConnection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MSK VpcConnection 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)— MSK VpcConnection resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: batch_scram_secret, channel, cluster, cluster_policy, configuration, replicator, serverless_cluster, topic, vpc_connection
2026.10.13.1
- Updated: batch_scram_secret, channel, cluster, cluster_policy, configuration, replicator, serverless_cluster, topic, vpc_connection
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
05Stats
A
100 / 100
Downloads
35
Archive size
1.8 MB
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
06Platforms
07Labels