Aws/kinesis
@swamp/aws/kinesisv2026.10.25.1
01README
AWS KINESIS infrastructure models
02Release Notes
- Updated: channel
03Behaviors
@swamp/aws/kinesis/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 | The name of the channel. The name's uniqueness is scoped per AWS account and region. |
| EncryptionConfiguration? | object | Server-side encryption configuration for data at rest. |
| S3DestinationConfiguration? | object | Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified. |
| LoggingConfiguration? | object | Configuration for delivering channel operational logs. Defaults to CloudWatch Logs disabled. |
| StreamConfigurationList | array | List of stream configurations associated with the channel. v1 supports a single element; the list shape allows future extensibility to fan in from multiple streams. |
| ServiceExecutionRoleARN | string | The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs. |
| S3TablesDestinationConfiguration? | object | Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified. |
| Tags? | array | An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel. |
fn create()
Create a Kinesis Channel
fn get(identifier: string)
Get a Kinesis Channel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis Channel |
fn update()
Update a Kinesis Channel
fn delete(identifier: string)
Delete a Kinesis Channel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis Channel |
fn sync()
Sync Kinesis Channel state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kinesis 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)— Kinesis Channel resource state
@swamp/aws/kinesis/resource-policyv2026.10.23.1resource_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. |
| ResourceArn | string | The ARN of the AWS Kinesis resource to which the policy applies. |
| ResourcePolicy | record | A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. |
fn create()
Create a Kinesis ResourcePolicy
fn get(identifier: string)
Get a Kinesis ResourcePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis ResourcePolicy |
fn update()
Update a Kinesis ResourcePolicy
fn delete(identifier: string)
Delete a Kinesis ResourcePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis ResourcePolicy |
fn sync()
Sync Kinesis ResourcePolicy state from AWS
Resources
state(infinite)— Kinesis ResourcePolicy resource state
@swamp/aws/kinesis/streamv2026.10.23.1stream.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. |
| Name? | string | The name of the Kinesis stream. |
| DesiredShardLevelMetrics? | array | The final list of shard-level metrics |
| RetentionPeriodHours? | number | The number of hours for the data records that are stored in shards to remain accessible. |
| ShardCount? | number | The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed. |
| StreamModeDetails? | object | The mode in which the stream is running. |
| StreamEncryption? | object | When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. |
| Tags? | array | An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream. |
| MaxRecordSizeInKiB? | number | Maximum size of a data record in KiB allowed to be put into Kinesis stream. |
| WarmThroughputMiBps? | number | Target warm throughput in MiB/s for the stream. This property can ONLY be set when StreamMode is ON_DEMAND. |
| WarmThroughputObject? | object | Warm throughput configuration details for the stream. Only present for ON_DEMAND streams. |
| RecordDistributionStrategy? | enum | The record distribution strategy for the stream. This property can ONLY be set when StreamMode is ON_DEMAND |
fn create()
Create a Kinesis Stream
fn get(identifier: string)
Get a Kinesis Stream
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis Stream |
fn update()
Update a Kinesis Stream
fn delete(identifier: string)
Delete a Kinesis Stream
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis Stream |
fn sync()
Sync Kinesis Stream state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kinesis Stream 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)— Kinesis Stream resource state
@swamp/aws/kinesis/stream-consumerv2026.10.23.1stream_consumer.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. |
| ConsumerName | string | The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams. |
| StreamARN | string | The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with. |
| Tags? | array | An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer. |
fn create()
Create a Kinesis StreamConsumer
fn get(identifier: string)
Get a Kinesis StreamConsumer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis StreamConsumer |
fn delete(identifier: string)
Delete a Kinesis StreamConsumer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kinesis StreamConsumer |
fn sync()
Sync Kinesis StreamConsumer state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kinesis StreamConsumer 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)— Kinesis StreamConsumer resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: channel, resource_policy, stream, stream_consumer
2026.10.13.1
- Updated: channel, resource_policy, stream, stream_consumer
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
- Updated: stream
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
830.2 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
06Platforms
07Labels