AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

SplunkDestinationConfiguration

import "github.com/aws/aws-sdk-go/service/firehose"

type SplunkDestinationConfiguration struct { CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` HECAcknowledgmentTimeoutInSeconds *int64 `min:"180" type:"integer"` HECEndpoint *string `type:"string" required:"true"` HECEndpointType *string `type:"string" required:"true" enum:"HECEndpointType"` HECToken *string `type:"string" required:"true"` ProcessingConfiguration *ProcessingConfiguration `type:"structure"` RetryOptions *SplunkRetryOptions `type:"structure"` S3BackupMode *string `type:"string" enum:"SplunkS3BackupMode"` S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` }

Describes the configuration of a destination in Splunk.

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

HECAcknowledgmentTimeoutInSeconds

Type: *int64

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

HECEndpoint

Type: *string

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

HECEndpoint is a required field

HECEndpointType

Type: *string

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

HECEndpointType is a required field

HECToken

Type: *string

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

HECToken is a required field

ProcessingConfiguration

Describes a data processing configuration.

RetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.

S3BackupMode

Type: *string

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

S3Configuration

Describes the configuration of a destination in Amazon S3.

Method

GoString

func (s SplunkDestinationConfiguration) GoString() string

GoString returns the string representation

SetCloudWatchLoggingOptions

func (s *SplunkDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SplunkDestinationConfiguration

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

SetHECAcknowledgmentTimeoutInSeconds

func (s *SplunkDestinationConfiguration) SetHECAcknowledgmentTimeoutInSeconds(v int64) *SplunkDestinationConfiguration

SetHECAcknowledgmentTimeoutInSeconds sets the HECAcknowledgmentTimeoutInSeconds field's value.

SetHECEndpoint

func (s *SplunkDestinationConfiguration) SetHECEndpoint(v string) *SplunkDestinationConfiguration

SetHECEndpoint sets the HECEndpoint field's value.

SetHECEndpointType

func (s *SplunkDestinationConfiguration) SetHECEndpointType(v string) *SplunkDestinationConfiguration

SetHECEndpointType sets the HECEndpointType field's value.

SetHECToken

func (s *SplunkDestinationConfiguration) SetHECToken(v string) *SplunkDestinationConfiguration

SetHECToken sets the HECToken field's value.

SetProcessingConfiguration

func (s *SplunkDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *SplunkDestinationConfiguration

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

SetRetryOptions

func (s *SplunkDestinationConfiguration) SetRetryOptions(v *SplunkRetryOptions) *SplunkDestinationConfiguration

SetRetryOptions sets the RetryOptions field's value.

SetS3BackupMode

func (s *SplunkDestinationConfiguration) SetS3BackupMode(v string) *SplunkDestinationConfiguration

SetS3BackupMode sets the S3BackupMode field's value.

SetS3Configuration

func (s *SplunkDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *SplunkDestinationConfiguration

SetS3Configuration sets the S3Configuration field's value.

String

func (s SplunkDestinationConfiguration) String() string

String returns the string representation

Validate

func (s *SplunkDestinationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: