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.

SplunkDestinationDescription

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

type SplunkDestinationDescription struct { CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` HECAcknowledgmentTimeoutInSeconds *int64 `min:"180" type:"integer"` HECEndpoint *string `type:"string"` HECEndpointType *string `type:"string" enum:"HECEndpointType"` HECToken *string `type:"string"` ProcessingConfiguration *ProcessingConfiguration `type:"structure"` RetryOptions *SplunkRetryOptions `type:"structure"` S3BackupMode *string `type:"string" enum:"SplunkS3BackupMode"` S3DestinationDescription *S3DestinationDescription `type:"structure"` }

Describes 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.

HECEndpointType

Type: *string

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

HECToken

Type: *string

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

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.

S3DestinationDescription

Describes a destination in Amazon S3.

Method

GoString

func (s SplunkDestinationDescription) GoString() string

GoString returns the string representation

SetCloudWatchLoggingOptions

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

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

SetHECAcknowledgmentTimeoutInSeconds

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

SetHECAcknowledgmentTimeoutInSeconds sets the HECAcknowledgmentTimeoutInSeconds field's value.

SetHECEndpoint

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

SetHECEndpoint sets the HECEndpoint field's value.

SetHECEndpointType

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

SetHECEndpointType sets the HECEndpointType field's value.

SetHECToken

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

SetHECToken sets the HECToken field's value.

SetProcessingConfiguration

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

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

SetRetryOptions

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

SetRetryOptions sets the RetryOptions field's value.

SetS3BackupMode

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

SetS3BackupMode sets the S3BackupMode field's value.

SetS3DestinationDescription

func (s *SplunkDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *SplunkDestinationDescription

SetS3DestinationDescription sets the S3DestinationDescription field's value.

String

func (s SplunkDestinationDescription) String() string

String returns the string representation

On this page: