Amazon QLDB · JSON Structure

Amazon Qldb Kinesis Configuration Structure

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

Type: object Properties: 2 Required: 1
BlockchainDatabaseLedger

KinesisConfiguration is a JSON Structure definition published by Amazon QLDB, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

StreamArn AggregationEnabled

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-qldb/refs/heads/main/json-structure/amazon-qldb-kinesis-configuration-structure.json",
  "name": "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"
  ]
}