Amazon Managed Service for Apache Flink · JSON Structure

Amazon Managed Apache Flink S3 Reference Data Source Description Structure

For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.

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

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

Properties

BucketARN FileKey ReferenceRoleARN

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-s3-reference-data-source-description-structure.json",
  "name": "S3ReferenceDataSourceDescription",
  "description": "For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.",
  "type": "object",
  "properties": {
    "BucketARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BucketARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the S3 bucket."
        }
      ]
    },
    "FileKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileKey"
        },
        {
          "description": "Amazon S3 object key name."
        }
      ]
    },
    "ReferenceRoleARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleARN"
        },
        {
          "description": "<p>The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table. </p> <note> <p>Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "BucketARN",
    "FileKey"
  ]
}