AWS Kinesis · Schema

CreateStreamInput

Represents the input for CreateStream.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StreamName object
ShardCount object
StreamModeDetails object
View JSON Schema on GitHub

JSON Schema

kinesis-createstreaminput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateStreamInput",
  "title": "CreateStreamInput",
  "type": "object",
  "required": [
    "StreamName"
  ],
  "properties": {
    "StreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamName"
        },
        {
          "description": "A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name."
        }
      ]
    },
    "ShardCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveIntegerObject"
        },
        {
          "description": "The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput."
        }
      ]
    },
    "StreamModeDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamModeDetails"
        },
        {
          "description": " Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams."
        }
      ]
    }
  },
  "description": "Represents the input for <code>CreateStream</code>."
}