Amazon QLDB · Schema

KinesisConfiguration

The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.

BlockchainDatabaseLedger

Properties

Name Type Description
StreamArn object
AggregationEnabled object
View JSON Schema on GitHub

JSON Schema

amazon-qldb-kinesis-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-qldb/refs/heads/main/json-schema/amazon-qldb-kinesis-configuration-schema.json",
  "title": "KinesisConfiguration",
  "description": "The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.",
  "type": "object",
  "properties": {
    "StreamArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the Kinesis Data Streams resource."
        }
      ]
    },
    "AggregationEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "<p>Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.</p> <p> <i>This option is enabled by default.</i> Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see <a href=\"https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html\">KPL Key Concepts</a> and <a href=\"https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html\">Consumer De-aggregation</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>"
        }
      ]
    }
  },
  "required": [
    "StreamArn"
  ]
}