Amazon Eventbridge Pipes Pipe Source Kinesis Stream Parameters Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-structure/amazon-eventbridge-pipes-pipe-source-kinesis-stream-parameters-structure.json",
  "name": "PipeSourceKinesisStreamParameters",
  "description": "The parameters for using a Kinesis stream as a source.",
  "type": "object",
  "properties": {
    "BatchSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LimitMax10000"
        },
        {
          "description": "The maximum number of records to include in each batch."
        }
      ]
    },
    "DeadLetterConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeadLetterConfig"
        },
        {
          "description": "Define the target queue to send dead-letter queue events to."
        }
      ]
    },
    "MaximumBatchingWindowInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaximumBatchingWindowInSeconds"
        },
        {
          "description": "The maximum length of a time to wait for events."
        }
      ]
    },
    "MaximumRecordAgeInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaximumRecordAgeInSeconds"
        },
        {
          "description": "(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records. "
        }
      ]
    },
    "MaximumRetryAttempts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaximumRetryAttemptsESM"
        },
        {
          "description": "(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source."
        }
      ]
    },
    "OnPartialBatchItemFailure": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OnPartialBatchItemFailureStreams"
        },
        {
          "description": "(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch."
        }
      ]
    },
    "ParallelizationFactor": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LimitMax10"
        },
        {
          "description": "(Streams only) The number of batches to process concurrently from each shard. The default value is 1."
        }
      ]
    },
    "StartingPosition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KinesisStreamStartPosition"
        },
        {
          "description": "(Streams only) The position in a stream from which to start reading."
        }
      ]
    },
    "StartingPositionTimestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading, in Unix time seconds."
        }
      ]
    }
  },
  "required": [
    "StartingPosition"
  ]
}