/AWS1/CL_FRHSPLUNKDSTCONF

Describes the configuration of a destination in Splunk.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_HECENDPOINT TYPE /AWS1/FRHHECENDPOINT /AWS1/FRHHECENDPOINT

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

IV_HECENDPOINTTYPE TYPE /AWS1/FRHHECENDPOINTTYPE /AWS1/FRHHECENDPOINTTYPE

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

IO_S3CONFIGURATION TYPE REF TO /AWS1/CL_FRHS3DESTINATIONCONF /AWS1/CL_FRHS3DESTINATIONCONF

The configuration for the backup Amazon S3 location.

Optional arguments:

IV_HECTOKEN TYPE /AWS1/FRHHECTOKEN /AWS1/FRHHECTOKEN

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

IV_HECACKNOWLEDGMENTTMOUTI00 TYPE /AWS1/FRHHECACKNOWLEDGMENTTO00 /AWS1/FRHHECACKNOWLEDGMENTTO00

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.

IO_RETRYOPTIONS TYPE REF TO /AWS1/CL_FRHSPLUNKRETRYOPTIONS /AWS1/CL_FRHSPLUNKRETRYOPTIONS

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.

IV_S3BACKUPMODE TYPE /AWS1/FRHSPLUNKS3BACKUPMODE /AWS1/FRHSPLUNKS3BACKUPMODE

Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, 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.

IO_PROCESSINGCONFIGURATION TYPE REF TO /AWS1/CL_FRHPROCESSINGCONF /AWS1/CL_FRHPROCESSINGCONF

The data processing configuration.

IO_CLOUDWATCHLOGGINGOPTIONS TYPE REF TO /AWS1/CL_FRHCLOUDWATCHLOGOPTS /AWS1/CL_FRHCLOUDWATCHLOGOPTS

The Amazon CloudWatch logging options for your Firehose stream.

IO_BUFFERINGHINTS TYPE REF TO /AWS1/CL_FRHSPLUNKBUFFERINGH00 /AWS1/CL_FRHSPLUNKBUFFERINGH00

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

IO_SECRETSMANAGERCONF TYPE REF TO /AWS1/CL_FRHSECRETSMANAGERCONF /AWS1/CL_FRHSECRETSMANAGERCONF

The configuration that defines how you access secrets for Splunk.

---

Queryable Attributes

HECEndpoint

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

Accessible with the following methods

Method	Description
GET_HECENDPOINT()	Getter for HECENDPOINT, with configurable default
ASK_HECENDPOINT()	Getter for HECENDPOINT w/ exceptions if field has no value
HAS_HECENDPOINT()	Determine if HECENDPOINT has a value

HECEndpointType

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

Accessible with the following methods

Method	Description
GET_HECENDPOINTTYPE()	Getter for HECENDPOINTTYPE, with configurable default
ASK_HECENDPOINTTYPE()	Getter for HECENDPOINTTYPE w/ exceptions if field has no val
HAS_HECENDPOINTTYPE()	Determine if HECENDPOINTTYPE has a value

HECToken

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

Accessible with the following methods

Method	Description
GET_HECTOKEN()	Getter for HECTOKEN, with configurable default
ASK_HECTOKEN()	Getter for HECTOKEN w/ exceptions if field has no value
HAS_HECTOKEN()	Determine if HECTOKEN has a value

HECAcknowledgmentTimeoutInSeconds

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.

Accessible with the following methods

Method	Description
GET_HECACKNOWLEDGMENTTMOUT00()	Getter for HECACKNOWLEDGMENTTMOUTINSECS, with configurable d
ASK_HECACKNOWLEDGMENTTMOUT00()	Getter for HECACKNOWLEDGMENTTMOUTINSECS w/ exceptions if fie
HAS_HECACKNOWLEDGMENTTMOUT00()	Determine if HECACKNOWLEDGMENTTMOUTINSECS has a value

RetryOptions

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.

Accessible with the following methods

Method	Description
GET_RETRYOPTIONS()	Getter for RETRYOPTIONS

S3BackupMode

Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, 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.

Accessible with the following methods

Method	Description
GET_S3BACKUPMODE()	Getter for S3BACKUPMODE, with configurable default
ASK_S3BACKUPMODE()	Getter for S3BACKUPMODE w/ exceptions if field has no value
HAS_S3BACKUPMODE()	Determine if S3BACKUPMODE has a value

S3Configuration

The configuration for the backup Amazon S3 location.

Accessible with the following methods

Method	Description
GET_S3CONFIGURATION()	Getter for S3CONFIGURATION

ProcessingConfiguration

The data processing configuration.

Accessible with the following methods

Method	Description
GET_PROCESSINGCONFIGURATION()	Getter for PROCESSINGCONFIGURATION

CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your Firehose stream.

Accessible with the following methods

Method	Description
GET_CLOUDWATCHLOGGINGOPTIONS()	Getter for CLOUDWATCHLOGGINGOPTIONS

BufferingHints

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

Accessible with the following methods

Method	Description
GET_BUFFERINGHINTS()	Getter for BUFFERINGHINTS

SecretsManagerConfiguration

The configuration that defines how you access secrets for Splunk.

Accessible with the following methods

Method	Description
GET_SECRETSMANAGERCONF()	Getter for SECRETSMANAGERCONFIGURATION