Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/k6/v2.3.x/javascript-api/jslib/aws/kinesisclient/createstream.md, or by sending Accept: text/markdown to https://grafana.com/docs/k6/v2.3.x/javascript-api/jslib/aws/kinesisclient/createstream/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
createStream
KinesisClient.createStream(streamName, [options]) creates a new Kinesis stream.
Parameters
| Parameter | Type | Description |
|---|---|---|
| streamName | string | The name of the Kinesis stream to create. |
| options | object | Optional configuration for the stream creation. |
Options
| Parameter | Type | Description |
|---|---|---|
| shardCount | number | The number of shards for the stream (for provisioned mode). |
| streamModeDetails | object | Configuration for the stream mode. |
| streamModeDetails.streamMode | string | The billing mode for the stream. Either PROVISIONED or ON_DEMAND. |
Returns
| Type | Description |
|---|---|
Promise<void> | A Promise that fulfills when the stream creation request is complete. |
Example
import {
AWSConfig,
KinesisClient,
} from 'https://jslib.k6.io/aws/0.14.0/kinesis.js';
const awsConfig = new AWSConfig({
region: __ENV.AWS_REGION,
accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});
const kinesis = new KinesisClient(awsConfig);
export default async function () {
// Create a stream with provisioned billing and 2 shards
await kinesis.createStream('my-provisioned-stream', {
shardCount: 2,
});
// Create a stream with on-demand billing
await kinesis.createStream('my-on-demand-stream', {
streamModeDetails: {
streamMode: 'ON_DEMAND',
},
});
}Was this page helpful?
Related resources from Grafana Labs

