AWS::KinesisFirehose::DeliveryStream HttpEndpointDestinationConfiguration

Describes the configuration of the HTTP endpoint destination. Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BufferingHints" : BufferingHints,
  "CloudWatchLoggingOptions" : CloudWatchLoggingOptions,
  "EndpointConfiguration" : HttpEndpointConfiguration,
  "ProcessingConfiguration" : ProcessingConfiguration,
  "RequestConfiguration" : HttpEndpointRequestConfiguration,
  "RetryOptions" : RetryOptions,
  "RoleARN" : String,
  "S3BackupMode" : String,
  "S3Configuration" : S3DestinationConfiguration
}

YAML

  BufferingHints: 
    BufferingHints
  CloudWatchLoggingOptions: 
    CloudWatchLoggingOptions
  EndpointConfiguration: 
    HttpEndpointConfiguration
  ProcessingConfiguration: 
    ProcessingConfiguration
  RequestConfiguration: 
    HttpEndpointRequestConfiguration
  RetryOptions: 
    RetryOptions
  RoleARN: String
  S3BackupMode: String
  S3Configuration: 
    S3DestinationConfiguration

Properties

BufferingHints

The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

Required: No

Type: BufferingHints

Update requires: No interruption

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

Required: No

Type: CloudWatchLoggingOptions

Update requires: No interruption

EndpointConfiguration

The configuration of the HTTP endpoint selected as the destination.

Required: Yes

Type: HttpEndpointConfiguration

Update requires: No interruption

ProcessingConfiguration

Describes the data processing configuration.

Required: No

Type: ProcessingConfiguration

Update requires: No interruption

RequestConfiguration

The configuration of the request sent to the HTTP endpoint specified as the destination.

Required: No

Type: HttpEndpointRequestConfiguration

Update requires: No interruption

RetryOptions

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.

Required: No

Type: RetryOptions

Update requires: No interruption

RoleARN

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

Required: No

Type: String

Pattern: arn:.*

Minimum: 1

Maximum: 512

Update requires: No interruption

S3BackupMode

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

Required: No

Type: String

Allowed values: FailedDataOnly | AllData

Update requires: No interruption

S3Configuration

Describes the configuration of a destination in Amazon S3.

Required: Yes

Type: S3DestinationConfiguration

Update requires: No interruption