SplunkDestinationDescription ¶

class SplunkDestinationDescription(TypedDict, closed=True):
    hec_endpoint: NotRequired["capo_firehose.types.hec_endpoint.HECEndpoint"]
    """<p>The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.</p>"""
    hec_endpoint_type: NotRequired[
        "capo_firehose.types.hec_endpoint_type.HECEndpointType"
    ]
    """<p>This type can be either "Raw" or "Event."</p>"""
    hec_token: NotRequired["capo_firehose.types.hec_token.HECToken"]
    """<p>A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.</p>"""
    hec_acknowledgment_timeout_in_seconds: NotRequired[
        "capo_firehose.types.hec_acknowledgment_timeout_in_seconds.HECAcknowledgmentTimeoutInSeconds"
    ]
    """<p>The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>"""
    retry_options: NotRequired[
        "capo_firehose.types.splunk_retry_options.SplunkRetryOptions"
    ]
    """<p>The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.</p>"""
    s3_backup_mode: NotRequired[
        "capo_firehose.types.splunk_s3_backup_mode.SplunkS3BackupMode"
    ]
    """<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>"""
    s3_destination_description: NotRequired[
        "capo_firehose.types.s3_destination_description.S3DestinationDescription"
    ]
    """<p>The Amazon S3 destination.></p>"""
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    """<p>The data processing configuration.</p>"""
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    """<p>The Amazon CloudWatch logging options for your Firehose stream.</p>"""
    buffering_hints: NotRequired[
        "capo_firehose.types.splunk_buffering_hints.SplunkBufferingHints"
    ]
    """<p>The buffering options. If no value is specified, the default values for Splunk are used.</p>"""
    secrets_manager_configuration: NotRequired[
        "capo_firehose.types.secrets_manager_configuration.SecretsManagerConfiguration"
    ]
    """<p> The configuration that defines how you access secrets for Splunk. </p>"""