AWS Kinesis · Schema

HttpEndpointDestinationDescription

Describes the HTTP endpoint destination.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
EndpointConfiguration object
BufferingHints object
CloudWatchLoggingOptions object
RequestConfiguration object
ProcessingConfiguration object
RoleARN object
RetryOptions object
S3BackupMode object
S3DestinationDescription object
View JSON Schema on GitHub

JSON Schema

kinesis-httpendpointdestinationdescription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HttpEndpointDestinationDescription",
  "title": "HttpEndpointDestinationDescription",
  "type": "object",
  "properties": {
    "EndpointConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HttpEndpointDescription"
        },
        {
          "description": "The configuration of the specified HTTP endpoint destination."
        }
      ]
    },
    "BufferingHints": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HttpEndpointBufferingHints"
        },
        {
          "description": "Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it might choose to use more optimal values. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code> parameters are optional. However, if specify a value for one of them, you must also provide a value for the other. "
        }
      ]
    },
    "CloudWatchLoggingOptions": {
      "$ref": "#/components/schemas/CloudWatchLoggingOptions"
    },
    "RequestConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HttpEndpointRequestConfiguration"
        },
        {
          "description": "The configuration of request sent to the HTTP endpoint specified as the destination."
        }
      ]
    },
    "ProcessingConfiguration": {
      "$ref": "#/components/schemas/ProcessingConfiguration"
    },
    "RoleARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleARN"
        },
        {
          "description": "Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs."
        }
      ]
    },
    "RetryOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HttpEndpointRetryOptions"
        },
        {
          "description": "Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination."
        }
      ]
    },
    "S3BackupMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HttpEndpointS3BackupMode"
        },
        {
          "description": "Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (<code>AllData</code>) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (<code>FailedDataOnly</code>)."
        }
      ]
    },
    "S3DestinationDescription": {
      "$ref": "#/components/schemas/S3DestinationDescription"
    }
  },
  "description": "Describes the HTTP endpoint destination."
}