HttpEndpointProps

class aws_cdk.aws_kinesisfirehose.HttpEndpointProps(*, logging_config=None, processor=None, processors=None, role=None, s3_backup=None, endpoint_config, attributes=None, backup_mode=None, buffering_hints=None, request_compression=None, retry_options=None)

Bases: CommonDestinationProps

Props for defining an Http destination of a Kinesis Data Firehose delivery stream.

Parameters:

  • logging_config (Optional[ILoggingConfig]) – Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs. Default: - errors will be logged and a log group will be created for you.

  • processor (Optional[IDataProcessor]) – (deprecated) The data transformation that should be performed on the data before writing to the destination. Default: - no data transformation will occur.

  • processors (Optional[Sequence[IDataProcessor]]) – The data transformation that should be performed on the data before writing to the destination. Default: - no data transformation will occur.

  • role (Optional[IRole]) – The IAM role associated with this destination. Assumed by Amazon Data Firehose to invoke processors and write to destinations Default: - a role will be created with default permissions.

  • s3_backup (Union[DestinationS3BackupProps, Dict[str, Any], None]) – The configuration for backing up source records to S3. Default: - source records will not be backed up to S3.

  • endpoint_config (Union[HttpEndpointConfig, Dict[str, Any]]) – Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.

  • attributes (Optional[Sequence[Union[HttpAttribute, Dict[str, Any]]]]) – Describes the metadata sent to the Http endpoint destination. Default: - None

  • backup_mode (Optional[HttpBackupMode]) – Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the Http endpoint destination. Default: - Failed data only

  • buffering_hints (Union[HttpBufferingHints, Dict[str, Any], None]) – The buffering options that can be used before data is delivered to the specified destination. Default: - None

  • request_compression (Optional[HttpCompression]) – Compress the body of a request before sending the request to the destination. Default: - None

  • retry_options (Union[HttpRetryOptions, Dict[str, Any], None]) – The total amount of time that Kinesis Data Firehose spends on retries. Default: - None

ExampleMetadata:

infused

Example:

# endpoint_config: firehose.HttpEndpointConfig

http_destination = firehose.HttpEndpoint(
    endpoint_config=endpoint_config
)

Attributes

attributes

Describes the metadata sent to the Http endpoint destination.

Default:

  • None

backup_mode

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the Http endpoint destination.

Default:

  • Failed data only

buffering_hints

The buffering options that can be used before data is delivered to the specified destination.

Default:

  • None

endpoint_config

Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.

logging_config

Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

Default:

  • errors will be logged and a log group will be created for you.

processor

(deprecated) The data transformation that should be performed on the data before writing to the destination.

Default:

  • no data transformation will occur.

Deprecated:

Use processors instead.

Stability:

deprecated

processors

The data transformation that should be performed on the data before writing to the destination.

Default:

  • no data transformation will occur.

request_compression

Compress the body of a request before sending the request to the destination.

Default:

  • None

retry_options

The total amount of time that Kinesis Data Firehose spends on retries.

Default:

  • None

role

The IAM role associated with this destination.

Assumed by Amazon Data Firehose to invoke processors and write to destinations

Default:

  • a role will be created with default permissions.

s3_backup

The configuration for backing up source records to S3.

Default:

  • source records will not be backed up to S3.