Menu
Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow jslibbreadcrumb arrow awsbreadcrumb arrow KinesisClientbreadcrumb arrow createStream
Open source

createStream

KinesisClient.createStream(streamName, [options]) creates a new Kinesis stream.

Parameters

ParameterTypeDescription
streamNamestringThe name of the Kinesis stream to create.
optionsobjectOptional configuration for the stream creation.

Options

ParameterTypeDescription
shardCountnumberThe number of shards for the stream (for provisioned mode).
streamModeDetailsobjectConfiguration for the stream mode.
streamModeDetails.streamModestringThe billing mode for the stream. Either PROVISIONED or ON_DEMAND.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the stream creation request is complete.

Example

JavaScript 
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',
    },
  });
}