Skip to main content
← back to extensions

@swamp/aws/kinesis

v2026.04.23.3

AWS KINESIS infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awskinesiscloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/kinesis

@swamp/aws/kinesis/resource-policyv2026.04.23.2resource_policy.ts

Global Arguments

ArgumentTypeDescription
ResourceArnstringThe ARN of the AWS Kinesis resource to which the policy applies.
ResourcePolicystringA 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.
createCreate a Kinesis ResourcePolicy
getGet a Kinesis ResourcePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the Kinesis ResourcePolicy
updateUpdate a Kinesis ResourcePolicy
deleteDelete a Kinesis ResourcePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the Kinesis ResourcePolicy
syncSync Kinesis ResourcePolicy state from AWS

Resources

state(infinite)— Kinesis ResourcePolicy resource state
@swamp/aws/kinesis/streamv2026.04.23.2stream.ts

Global Arguments

ArgumentTypeDescription
Name?stringThe name of the Kinesis stream.
DesiredShardLevelMetrics?arrayThe final list of shard-level metrics
RetentionPeriodHours?numberThe number of hours for the data records that are stored in shards to remain accessible.
ShardCount?numberThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
StreamModeDetails?objectThe mode in which the stream is running.
StreamEncryption?objectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
Tags?arrayAn arbitrary set of tags (key-value pairs) to associate with the Kinesis stream.
MaxRecordSizeInKiB?numberMaximum size of a data record in KiB allowed to be put into Kinesis stream.
WarmThroughputMiBps?numberTarget warm throughput in MiB/s for the stream. This property can ONLY be set when StreamMode is ON_DEMAND.
WarmThroughputObject?objectWarm throughput configuration details for the stream. Only present for ON_DEMAND streams.
createCreate a Kinesis Stream
getGet a Kinesis Stream
ArgumentTypeDescription
identifierstringThe primary identifier of the Kinesis Stream
updateUpdate a Kinesis Stream
deleteDelete a Kinesis Stream
ArgumentTypeDescription
identifierstringThe primary identifier of the Kinesis Stream
syncSync Kinesis Stream state from AWS

Resources

state(infinite)— Kinesis Stream resource state
@swamp/aws/kinesis/stream-consumerv2026.04.23.2stream_consumer.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ConsumerNamestringThe 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.
StreamARNstringThe Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
Tags?arrayAn arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
createCreate a Kinesis StreamConsumer
getGet a Kinesis StreamConsumer
ArgumentTypeDescription
identifierstringThe primary identifier of the Kinesis StreamConsumer
deleteDelete a Kinesis StreamConsumer
ArgumentTypeDescription
identifierstringThe primary identifier of the Kinesis StreamConsumer
syncSync Kinesis StreamConsumer state from AWS

Resources

state(infinite)— Kinesis StreamConsumer resource state