Class CfnDeliveryStream.SplunkDestinationConfigurationProperty
The SplunkDestinationConfiguration
property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.AWS.KinesisFirehose.dll
Syntax (csharp)
public class SplunkDestinationConfigurationProperty : Object, CfnDeliveryStream.ISplunkDestinationConfigurationProperty
Syntax (vb)
Public Class SplunkDestinationConfigurationProperty
Inherits Object
Implements CfnDeliveryStream.ISplunkDestinationConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisFirehose;
var splunkDestinationConfigurationProperty = new SplunkDestinationConfigurationProperty {
HecEndpoint = "hecEndpoint",
HecEndpointType = "hecEndpointType",
HecToken = "hecToken",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
HecAcknowledgmentTimeoutInSeconds = 123,
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new SplunkRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode"
};
Synopsis
Constructors
SplunkDestinationConfigurationProperty() |
Properties
CloudWatchLoggingOptions | The Amazon CloudWatch logging options for your delivery stream. |
HecAcknowledgmentTimeoutInSeconds | The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. |
HecEndpoint | The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data. |
HecEndpointType | This type can be either |
HecToken | This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. |
ProcessingConfiguration | The data processing configuration. |
RetryOptions | The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk. |
S3BackupMode | Defines how documents should be delivered to Amazon S3. |
S3Configuration | The configuration for the backup Amazon S3 location. |
Constructors
SplunkDestinationConfigurationProperty()
public SplunkDestinationConfigurationProperty()
Properties
CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
public object CloudWatchLoggingOptions { get; set; }
Property Value
System.Object
Remarks
HecAcknowledgmentTimeoutInSeconds
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data.
public Nullable<double> HecAcknowledgmentTimeoutInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
public string HecEndpoint { get; set; }
Property Value
System.String
Remarks
HecEndpointType
This type can be either Raw
or Event
.
public string HecEndpointType { get; set; }
Property Value
System.String
Remarks
HecToken
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
public string HecToken { get; set; }
Property Value
System.String
Remarks
ProcessingConfiguration
The data processing configuration.
public object ProcessingConfiguration { get; set; }
Property Value
System.Object
Remarks
RetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
public object RetryOptions { get; set; }
Property Value
System.Object
Remarks
S3BackupMode
Defines how documents should be delivered to Amazon S3.
public string S3BackupMode { get; set; }
Property Value
System.String
Remarks
When set to FailedEventsOnly
, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents
, Kinesis Data 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
.
S3Configuration
The configuration for the backup Amazon S3 location.
public object S3Configuration { get; set; }
Property Value
System.Object