HttpEndpointDestinationDescription - Amazon Data Firehose
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

HttpEndpointDestinationDescription

Describes the HTTP endpoint destination.

Contents

BufferingHints

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

Type: HttpEndpointBufferingHints object

Required: No

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your Firehose stream.

Type: CloudWatchLoggingOptions object

Required: No

EndpointConfiguration

The configuration of the specified HTTP endpoint destination.

Type: HttpEndpointDescription object

Required: No

ProcessingConfiguration

Describes a data processing configuration.

Type: ProcessingConfiguration object

Required: No

RequestConfiguration

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

Type: HttpEndpointRequestConfiguration object

Required: No

RetryOptions

Describes the retry behavior in case 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.

Type: HttpEndpointRetryOptions object

Required: No

RoleARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: No

S3BackupMode

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

Type: String

Valid Values: FailedDataOnly | AllData

Required: No

S3DestinationDescription

Describes a destination in Amazon S3.

Type: S3DestinationDescription object

Required: No

SecretsManagerConfiguration

The configuration that defines how you access secrets for HTTP Endpoint destination.

Type: SecretsManagerConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: