AWS Kinesis · Schema

SchemaConfiguration

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
RoleARN object
CatalogId object
DatabaseName object
TableName object
Region object
VersionId object
View JSON Schema on GitHub

JSON Schema

kinesis-schemaconfiguration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SchemaConfiguration",
  "title": "SchemaConfiguration",
  "type": "object",
  "properties": {
    "RoleARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyStringWithoutWhitespace"
        },
        {
          "description": "<p>The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>RoleARN</code> property is required and its value must be specified.</p> </important>"
        }
      ]
    },
    "CatalogId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyStringWithoutWhitespace"
        },
        {
          "description": "The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default."
        }
      ]
    },
    "DatabaseName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyStringWithoutWhitespace"
        },
        {
          "description": "<p>Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>DatabaseName</code> property is required and its value must be specified.</p> </important>"
        }
      ]
    },
    "TableName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyStringWithoutWhitespace"
        },
        {
          "description": "<p>Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>TableName</code> property is required and its value must be specified.</p> </important>"
        }
      ]
    },
    "Region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyStringWithoutWhitespace"
        },
        {
          "description": "If you don't specify an Amazon Web Services Region, the default is the current Region."
        }
      ]
    },
    "VersionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyStringWithoutWhitespace"
        },
        {
          "description": "Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to <code>LATEST</code>, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up."
        }
      ]
    }
  },
  "description": "Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true."
}