Amazon Managed Apache Flink Input Description Structure

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

Type: object Properties: 9
Apache FlinkBig DataReal-Time ProcessingStreaming Analytics

InputDescription is a JSON Structure definition published by Amazon Managed Service for Apache Flink, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

InputId NamePrefix InAppStreamNames InputProcessingConfigurationDescription KinesisStreamsInputDescription KinesisFirehoseInputDescription InputSchema InputParallelism InputStartingPositionConfiguration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-managed-apache-flink/refs/heads/main/json-structure/amazon-managed-apache-flink-input-description-structure.json",
  "name": "InputDescription",
  "description": "Describes the application input configuration for a SQL-based Kinesis Data Analytics application. ",
  "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."
        }
      ]
    }
  }
}