Skip to content

SplunkDestinationUpdate

Source code in docs_src/capo_firehose/types/splunk_destination_update.py
class SplunkDestinationUpdate(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 that 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 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>Specifies how you want Firehose to back up documents 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>AllEvents</code>, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is <code>FailedEventsOnly</code>.</p> <p>You can update this backup mode from <code>FailedEventsOnly</code> to <code>AllEvents</code>. You can't update it from <code>AllEvents</code> to <code>FailedEventsOnly</code>.</p>"""
    s3_update: NotRequired[
        "capo_firehose.types.s3_destination_update.S3DestinationUpdate"
    ]
    """<p>Your update to the configuration of the backup Amazon S3 location.</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>"""

buffering_hints instance-attribute

buffering_hints: NotRequired[SplunkBufferingHints]

The buffering options. If no value is specified, the default values for Splunk are used.

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

The Amazon CloudWatch logging options for your Firehose stream.

hec_acknowledgment_timeout_in_seconds instance-attribute

hec_acknowledgment_timeout_in_seconds: NotRequired[HECAcknowledgmentTimeoutInSeconds]

The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends 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.

hec_endpoint instance-attribute

hec_endpoint: NotRequired[HECEndpoint]

The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

hec_endpoint_type instance-attribute

hec_endpoint_type: NotRequired[HECEndpointType]

This type can be either "Raw" or "Event."

hec_token instance-attribute

hec_token: NotRequired[HECToken]

A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

processing_configuration instance-attribute

processing_configuration: NotRequired[ProcessingConfiguration]

The data processing configuration.

retry_options instance-attribute

retry_options: NotRequired[SplunkRetryOptions]

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.

s3_backup_mode instance-attribute

s3_backup_mode: NotRequired[SplunkS3BackupMode]

Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

s3_update instance-attribute

s3_update: NotRequired[S3DestinationUpdate]

Your update to the configuration of the backup Amazon S3 location.

secrets_manager_configuration instance-attribute

secrets_manager_configuration: NotRequired[SecretsManagerConfiguration]

The configuration that defines how you access secrets for Splunk.