software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.SplunkDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.SplunkDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(value=Stable)
public static interface CfnDeliveryStream.SplunkDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The `SplunkDestinationConfiguration` property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 SplunkDestinationConfigurationProperty splunkDestinationConfigurationProperty = SplunkDestinationConfigurationProperty.builder()
         .hecEndpoint("hecEndpoint")
         .hecEndpointType("hecEndpointType")
         .hecToken("hecToken")
         .s3Configuration(S3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .bufferingHints(BufferingHintsProperty.builder()
                         .intervalInSeconds(123)
                         .sizeInMBs(123)
                         .build())
                 .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                         .enabled(false)
                         .logGroupName("logGroupName")
                         .logStreamName("logStreamName")
                         .build())
                 .compressionFormat("compressionFormat")
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                                 .awskmsKeyArn("awskmsKeyArn")
                                 .build())
                         .noEncryptionConfig("noEncryptionConfig")
                         .build())
                 .errorOutputPrefix("errorOutputPrefix")
                 .prefix("prefix")
                 .build())
         // the properties below are optional
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .hecAcknowledgmentTimeoutInSeconds(123)
         .processingConfiguration(ProcessingConfigurationProperty.builder()
                 .enabled(false)
                 .processors(List.of(ProcessorProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .parameters(List.of(ProcessorParameterProperty.builder()
                                 .parameterName("parameterName")
                                 .parameterValue("parameterValue")
                                 .build()))
                         .build()))
                 .build())
         .retryOptions(SplunkRetryOptionsProperty.builder()
                 .durationInSeconds(123)
                 .build())
         .s3BackupMode("s3BackupMode")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder A builder for CfnDeliveryStream.SplunkDestinationConfigurationProperty
static class	CfnDeliveryStream.SplunkDestinationConfigurationProperty.Jsii$Proxy An implementation for CfnDeliveryStream.SplunkDestinationConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder	builder()
default Object	getCloudWatchLoggingOptions() The Amazon CloudWatch logging options for your delivery stream.
default Number	getHecAcknowledgmentTimeoutInSeconds() The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data.
String	getHecEndpoint() The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
String	getHecEndpointType() This type can be either `Raw` or `Event` .
String	getHecToken() This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
default Object	getProcessingConfiguration() The data processing configuration.
default Object	getRetryOptions() 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.
default String	getS3BackupMode() Defines how documents should be delivered to Amazon S3.
Object	getS3Configuration() The configuration for the backup Amazon S3 location.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHecEndpoint

@Stability(value=Stable)
 @NotNull
String getHecEndpoint()

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

getHecEndpointType

@Stability(value=Stable)
 @NotNull
String getHecEndpointType()

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

getHecToken

@Stability(value=Stable)
 @NotNull
String getHecToken()

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

getS3Configuration

@Stability(value=Stable)
 @NotNull
Object getS3Configuration()

The configuration for the backup Amazon S3 location.

getCloudWatchLoggingOptions

@Stability(value=Stable)
 @Nullable
default Object getCloudWatchLoggingOptions()

The Amazon CloudWatch logging options for your delivery stream.

getHecAcknowledgmentTimeoutInSeconds

@Stability(value=Stable)
 @Nullable
default Number getHecAcknowledgmentTimeoutInSeconds()

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.

getProcessingConfiguration

@Stability(value=Stable)
 @Nullable
default Object getProcessingConfiguration()

The data processing configuration.

getRetryOptions

@Stability(value=Stable)
 @Nullable
default Object getRetryOptions()

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.

getS3BackupMode

@Stability(value=Stable)
 @Nullable
default String getS3BackupMode()

Defines how documents should be delivered to Amazon S3.

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 .

builder

@Stability(value=Stable)
static CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder of CfnDeliveryStream.SplunkDestinationConfigurationProperty