Class SplunkDestinationConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SplunkDestinationConfiguration.Builder,
SplunkDestinationConfiguration>
Describes the configuration of a destination in Splunk.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal SplunkBufferingHints
The buffering options.builder()
final CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.final String
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.final HECEndpointType
This type can be either "Raw" or "Event."final String
This type can be either "Raw" or "Event."final String
hecToken()
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.final ProcessingConfiguration
The data processing configuration.final SplunkRetryOptions
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.final SplunkS3BackupMode
Defines how documents should be delivered to Amazon S3.final String
Defines how documents should be delivered to Amazon S3.The configuration for the backup Amazon S3 location.static Class
<? extends SplunkDestinationConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hecEndpoint
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
- Returns:
- The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
-
hecEndpointType
This type can be either "Raw" or "Event."
If the service returns an enum value that is not available in the current SDK version,
hecEndpointType
will returnHECEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhecEndpointTypeAsString()
.- Returns:
- This type can be either "Raw" or "Event."
- See Also:
-
hecEndpointTypeAsString
This type can be either "Raw" or "Event."
If the service returns an enum value that is not available in the current SDK version,
hecEndpointType
will returnHECEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhecEndpointTypeAsString()
.- Returns:
- This type can be either "Raw" or "Event."
- See Also:
-
hecToken
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
- Returns:
- This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
-
hecAcknowledgmentTimeoutInSeconds
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.
- Returns:
- 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.
-
retryOptions
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:
- 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.
-
s3BackupMode
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 toAllEvents
, 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
.If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnSplunkS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- 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 toAllEvents
, 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
. - See Also:
-
s3BackupModeAsString
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 toAllEvents
, 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
.If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnSplunkS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- 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 toAllEvents
, 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
. - See Also:
-
s3Configuration
The configuration for the backup Amazon S3 location.
- Returns:
- The configuration for the backup Amazon S3 location.
-
processingConfiguration
The data processing configuration.
- Returns:
- The data processing configuration.
-
cloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
- Returns:
- The Amazon CloudWatch logging options for your delivery stream.
-
bufferingHints
The buffering options. If no value is specified, the default values for Splunk are used.
- Returns:
- The buffering options. If no value is specified, the default values for Splunk are used.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SplunkDestinationConfiguration.Builder,
SplunkDestinationConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-