AWS Kinesis · Schema

InputDescription

Describes the application input configuration for a SQL-based Kinesis Data Analytics application.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
InputId object
NamePrefix object
InAppStreamNames object
InputProcessingConfigurationDescription object
KinesisStreamsInputDescription object
KinesisFirehoseInputDescription object
InputSchema object
InputParallelism object
InputStartingPositionConfiguration object
View JSON Schema on GitHub

JSON Schema

kinesis-inputdescription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InputDescription",
  "title": "InputDescription",
  "type": "object",
  "properties": {
    "InputId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "description": "The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application. "
        }
      ]
    },
    "NamePrefix": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppStreamName"
        },
        {
          "description": "The in-application name prefix."
        }
      ]
    },
    "InAppStreamNames": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppStreamNames"
        },
        {
          "description": "Returns the in-application stream names that are mapped to the stream source. "
        }
      ]
    },
    "InputProcessingConfigurationDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputProcessingConfigurationDescription"
        },
        {
          "description": "The description of the preprocessor that executes on records in this input before the application's code is run. "
        }
      ]
    },
    "KinesisStreamsInputDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KinesisStreamsInputDescription"
        },
        {
          "description": "If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN). "
        }
      ]
    },
    "KinesisFirehoseInputDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KinesisFirehoseInputDescription"
        },
        {
          "description": "If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN. "
        }
      ]
    },
    "InputSchema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SourceSchema"
        },
        {
          "description": "Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. "
        }
      ]
    },
    "InputParallelism": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputParallelism"
        },
        {
          "description": "Describes the configured parallelism (number of in-application streams mapped to the streaming source). "
        }
      ]
    },
    "InputStartingPositionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputStartingPositionConfiguration"
        },
        {
          "description": "The point at which the application is configured to read from the input stream."
        }
      ]
    }
  },
  "description": "Describes the application input configuration for a SQL-based Kinesis Data Analytics application. "
}