ReferenceDataSourceDescription

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

Apache FlinkBig DataReal-Time ProcessingStreaming Analytics

Properties

Name Type Description
ReferenceId object
TableName object
S3ReferenceDataSourceDescription object
ReferenceSchema object
View JSON Schema on GitHub

JSON Schema

amazon-managed-apache-flink-reference-data-source-description-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-managed-apache-flink/refs/heads/main/json-schema/amazon-managed-apache-flink-reference-data-source-description-schema.json",
  "title": "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"
  ]
}