Amazon Managed Service for Apache Flink · JSON Structure

Amazon Managed Apache Flink Reference Data Source Update Structure

When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

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

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

Properties

ReferenceId TableNameUpdate S3ReferenceDataSourceUpdate ReferenceSchemaUpdate

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-update-structure.json",
  "name": "ReferenceDataSourceUpdate",
  "description": "When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.",
  "type": "object",
  "properties": {
    "ReferenceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "description": "The ID of the reference data source that is being updated. You can use the <a>DescribeApplication</a> operation to get this value."
        }
      ]
    },
    "TableNameUpdate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppTableName"
        },
        {
          "description": "The in-application table name that is created by this update."
        }
      ]
    },
    "S3ReferenceDataSourceUpdate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3ReferenceDataSourceUpdate"
        },
        {
          "description": "Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table."
        }
      ]
    },
    "ReferenceSchemaUpdate": {
      "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"
  ]
}