Amazon Managed Apache Flink Reference Data Source Description Structure

For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.

Type: object Properties: 4 Required: 3
Apache FlinkBig DataReal-Time ProcessingStreaming Analytics

ReferenceDataSourceDescription is a JSON Structure definition published by Amazon Managed Service for Apache Flink, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ReferenceId TableName S3ReferenceDataSourceDescription ReferenceSchema

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-reference-data-source-description-structure.json",
  "name": "ReferenceDataSourceDescription",
  "description": "For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.",
  "type": "object",
  "properties": {
    "ReferenceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "description": "The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the <a>CreateApplication</a> or <a>UpdateApplication</a> operation."
        }
      ]
    },
    "TableName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppTableName"
        },
        {
          "description": "The in-application table name created by the specific reference data source configuration."
        }
      ]
    },
    "S3ReferenceDataSourceDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3ReferenceDataSourceDescription"
        },
        {
          "description": "Provides the Amazon S3 bucket name, the object key name that contains the reference data. "
        }
      ]
    },
    "ReferenceSchema": {
      "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 created in the in-application stream."
        }
      ]
    }
  },
  "required": [
    "ReferenceId",
    "TableName",
    "S3ReferenceDataSourceDescription"
  ]
}