Skip to content

HttpEndpointDestinationDescription

Source code in docs_src/capo_firehose/types/http_endpoint_destination_description.py
class HttpEndpointDestinationDescription(TypedDict, closed=True):
    endpoint_configuration: NotRequired[
        "capo_firehose.types.http_endpoint_description.HttpEndpointDescription"
    ]
    """<p>The configuration of the specified HTTP endpoint destination.</p>"""
    buffering_hints: NotRequired[
        "capo_firehose.types.http_endpoint_buffering_hints.HttpEndpointBufferingHints"
    ]
    """<p>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 <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. </p>"""
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    request_configuration: NotRequired[
        "capo_firehose.types.http_endpoint_request_configuration.HttpEndpointRequestConfiguration"
    ]
    """<p>The configuration of request sent to the HTTP endpoint specified as the destination.</p>"""
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    role_arn: NotRequired["capo_firehose.types.role_arn.RoleARN"]
    """<p>Firehose uses this IAM role for all the permissions that the delivery stream needs.</p>"""
    retry_options: NotRequired[
        "capo_firehose.types.http_endpoint_retry_options.HttpEndpointRetryOptions"
    ]
    """<p>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.</p>"""
    s3_backup_mode: NotRequired[
        "capo_firehose.types.http_endpoint_s3_backup_mode.HttpEndpointS3BackupMode"
    ]
    """<p>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 Firehose could not deliver to the specified HTTP endpoint destination (<code>FailedDataOnly</code>).</p>"""
    s3_destination_description: NotRequired[
        "capo_firehose.types.s3_destination_description.S3DestinationDescription"
    ]
    secrets_manager_configuration: NotRequired[
        "capo_firehose.types.secrets_manager_configuration.SecretsManagerConfiguration"
    ]
    """<p> The configuration that defines how you access secrets for HTTP Endpoint destination. </p>"""

buffering_hints instance-attribute

buffering_hints: NotRequired[HttpEndpointBufferingHints]

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.

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

endpoint_configuration instance-attribute

endpoint_configuration: NotRequired[HttpEndpointDescription]

The configuration of the specified HTTP endpoint destination.

processing_configuration instance-attribute

processing_configuration: NotRequired[ProcessingConfiguration]

request_configuration instance-attribute

request_configuration: NotRequired[HttpEndpointRequestConfiguration]

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

retry_options instance-attribute

retry_options: NotRequired[HttpEndpointRetryOptions]

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.

role_arn instance-attribute

role_arn: NotRequired[RoleARN]

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

s3_backup_mode instance-attribute

s3_backup_mode: NotRequired[HttpEndpointS3BackupMode]

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).

s3_destination_description instance-attribute

s3_destination_description: NotRequired[S3DestinationDescription]

secrets_manager_configuration instance-attribute

secrets_manager_configuration: NotRequired[SecretsManagerConfiguration]

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