AWS Kinesis · Schema

DeletionConfig

The configuration details required to delete the connection of the stream from the Edge Agent.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
EdgeRetentionInHours object
LocalSizeConfig object
DeleteAfterUpload object
View JSON Schema on GitHub

JSON Schema

kinesis-deletionconfig-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeletionConfig",
  "title": "DeletionConfig",
  "type": "object",
  "properties": {
    "EdgeRetentionInHours": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EdgeRetentionInHours"
        },
        {
          "description": "The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days."
        }
      ]
    },
    "LocalSizeConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocalSizeConfig"
        },
        {
          "description": "The value of the local size required in order to delete the edge configuration."
        }
      ]
    },
    "DeleteAfterUpload": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeleteAfterUpload"
        },
        {
          "description": "<p>The <code>boolean</code> value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to <code>true</code>, such as when the limit for the <code>EdgeRetentionInHours</code>, or the <code>MaxLocalMediaSizeInMB</code>, has been reached. </p> <p>Since the default value is set to <code>true</code>, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to AWS cloud.</p>"
        }
      ]
    }
  },
  "description": "The configuration details required to delete the connection of the stream from the Edge Agent."
}