AWSFirehoseSplunkDestinationConfiguration

Objective-C

@interface AWSFirehoseSplunkDestinationConfiguration

Swift

class AWSFirehoseSplunkDestinationConfiguration

Describes the configuration of a destination in Splunk.

Required parameters: [HECEndpoint, HECEndpointType, HECToken, S3Configuration]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSFirehoseSplunkBufferingHints *_Nullable bufferingHints;

    Swift

    var bufferingHints: AWSFirehoseSplunkBufferingHints? { get set }
  • The Amazon CloudWatch logging options for your delivery stream.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSFirehoseCloudWatchLoggingOptions *_Nullable cloudWatchLoggingOptions;

    Swift

    var cloudWatchLoggingOptions: AWSFirehoseCloudWatchLoggingOptions? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable HECAcknowledgmentTimeoutInSeconds;

    Swift

    var hecAcknowledgmentTimeoutInSeconds: NSNumber? { get set }
  • The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable HECEndpoint;

    Swift

    var hecEndpoint: String? { get set }
  • This type can be either “Raw” or “Event.”

    Declaration

    Objective-C

    @property (nonatomic) AWSFirehoseHECEndpointType HECEndpointType;

    Swift

    var hecEndpointType: AWSFirehoseHECEndpointType { get set }
  • This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable HECToken;

    Swift

    var hecToken: String? { get set }
  • The data processing configuration.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSFirehoseProcessingConfiguration *_Nullable processingConfiguration;

    Swift

    var processingConfiguration: AWSFirehoseProcessingConfiguration? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSFirehoseSplunkRetryOptions *_Nullable retryOptions;

    Swift

    var retryOptions: AWSFirehoseSplunkRetryOptions? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSFirehoseSplunkS3BackupMode s3BackupMode;

    Swift

    var s3BackupMode: AWSFirehoseSplunkS3BackupMode { get set }
  • The configuration for the backup Amazon S3 location.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSFirehoseS3DestinationConfiguration *_Nullable s3Configuration;

    Swift

    var s3Configuration: AWSFirehoseS3DestinationConfiguration? { get set }