Class CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStream.SplunkDestinationConfigurationProperty>
- Enclosing interface:
CfnDeliveryStream.SplunkDestinationConfigurationProperty
@Stability(Stable)
public static final class CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStream.SplunkDestinationConfigurationProperty>
A builder for
CfnDeliveryStream.SplunkDestinationConfigurationProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.cloudWatchLoggingOptions
(IResolvable cloudWatchLoggingOptions) cloudWatchLoggingOptions
(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) hecAcknowledgmentTimeoutInSeconds
(Number hecAcknowledgmentTimeoutInSeconds) hecEndpoint
(String hecEndpoint) hecEndpointType
(String hecEndpointType) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getHecToken()
processingConfiguration
(IResolvable processingConfiguration) processingConfiguration
(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration) retryOptions
(IResolvable retryOptions) retryOptions
(CfnDeliveryStream.SplunkRetryOptionsProperty retryOptions) s3BackupMode
(String s3BackupMode) s3Configuration
(IResolvable s3Configuration) s3Configuration
(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
hecEndpoint
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder hecEndpoint(String hecEndpoint) - Parameters:
hecEndpoint
- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data. This parameter is required.- Returns:
this
-
hecEndpointType
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder hecEndpointType(String hecEndpointType) - Parameters:
hecEndpointType
- This type can be eitherRaw
orEvent
. This parameter is required.- Returns:
this
-
hecToken
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder hecToken(String hecToken) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getHecToken()
- Parameters:
hecToken
- This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint. This parameter is required.- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder s3Configuration(IResolvable s3Configuration) - Parameters:
s3Configuration
- The configuration for the backup Amazon S3 location. This parameter is required.- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder s3Configuration(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration) - Parameters:
s3Configuration
- The configuration for the backup Amazon S3 location. This parameter is required.- Returns:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getCloudWatchLoggingOptions()
- Parameters:
cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.- Returns:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getCloudWatchLoggingOptions()
- Parameters:
cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.- Returns:
this
-
hecAcknowledgmentTimeoutInSeconds
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder hecAcknowledgmentTimeoutInSeconds(Number hecAcknowledgmentTimeoutInSeconds) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getHecAcknowledgmentTimeoutInSeconds()
- Parameters:
hecAcknowledgmentTimeoutInSeconds
- 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.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder processingConfiguration(IResolvable processingConfiguration) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getProcessingConfiguration()
- Parameters:
processingConfiguration
- The data processing configuration.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder processingConfiguration(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration) Sets the value ofCfnDeliveryStream.SplunkDestinationConfigurationProperty.getProcessingConfiguration()
- Parameters:
processingConfiguration
- The data processing configuration.- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder retryOptions(IResolvable retryOptions) - Parameters:
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.- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStream.SplunkRetryOptionsProperty retryOptions) - Parameters:
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.- Returns:
this
-
s3BackupMode
@Stability(Stable) public CfnDeliveryStream.SplunkDestinationConfigurationProperty.Builder s3BackupMode(String s3BackupMode) - Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set toFailedEventsOnly
, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents
, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly
.You can update this backup mode from
FailedEventsOnly
toAllEvents
. You can't update it fromAllEvents
toFailedEventsOnly
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDeliveryStream.SplunkDestinationConfigurationProperty>
- Returns:
- a new instance of
CfnDeliveryStream.SplunkDestinationConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-