Package 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(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")
         .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
         .bufferingHints(SplunkBufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .hecAcknowledgmentTimeoutInSeconds(123)
         .hecToken("hecToken")
         .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")
         .secretsManagerConfiguration(SecretsManagerConfigurationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder	builder()
default Object	getBufferingHints()	The buffering options.
default Object	getCloudWatchLoggingOptions()	The Amazon CloudWatch logging options for your Firehose stream.
default Number	getHecAcknowledgmentTimeoutInSeconds()	The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.
String	getHecEndpoint()	The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
String	getHecEndpointType()	This type can be either Raw or Event .
default 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 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.
default Object	getSecretsManagerConfiguration()	The configuration that defines how you access secrets for Splunk.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHecEndpoint

@Stability(Stable)
@NotNull
String getHecEndpoint()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint

getHecEndpointType

@Stability(Stable)
@NotNull
String getHecEndpointType()

This type can be either Raw or Event .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype

getS3Configuration

@Stability(Stable)
@NotNull
Object getS3Configuration()

The configuration for the backup Amazon S3 location.

Returns union: either IResolvable or CfnDeliveryStream.S3DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration

getBufferingHints

@Stability(Stable)
@Nullable
default Object getBufferingHints()

The buffering options.

If no value is specified, the default values for Splunk are used.

Returns union: either IResolvable or CfnDeliveryStream.SplunkBufferingHintsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-bufferinghints

getCloudWatchLoggingOptions

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

The Amazon CloudWatch logging options for your Firehose stream.

Returns union: either IResolvable or CfnDeliveryStream.CloudWatchLoggingOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions

getHecAcknowledgmentTimeoutInSeconds

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds

getHecToken

@Stability(Stable)
@Nullable
default String getHecToken()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken

getProcessingConfiguration

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

The data processing configuration.

Returns union: either IResolvable or CfnDeliveryStream.ProcessingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration

getRetryOptions

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

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.

Returns union: either IResolvable or CfnDeliveryStream.SplunkRetryOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions

getS3BackupMode

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

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode

getSecretsManagerConfiguration

@Stability(Stable)
@Nullable
default Object getSecretsManagerConfiguration()

The configuration that defines how you access secrets for Splunk.

Returns union: either IResolvable or CfnDeliveryStream.SecretsManagerConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-secretsmanagerconfiguration

builder

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

Returns:

a CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder of CfnDeliveryStream.SplunkDestinationConfigurationProperty