Struct SplunkDestinationConfiguration 

#[non_exhaustive]
pub struct SplunkDestinationConfiguration {
    pub hec_endpoint: String,
    pub hec_endpoint_type: HecEndpointType,
    pub hec_token: Option<String>,
    pub hec_acknowledgment_timeout_in_seconds: Option<i32>,
    pub retry_options: Option<SplunkRetryOptions>,
    pub s3_backup_mode: Option<SplunkS3BackupMode>,
    pub s3_configuration: Option<S3DestinationConfiguration>,
    pub processing_configuration: Option<ProcessingConfiguration>,
    pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
    pub buffering_hints: Option<SplunkBufferingHints>,
    pub secrets_manager_configuration: Option<SecretsManagerConfiguration>,
}

Describes the configuration of a destination in Splunk.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hec_endpoint: String

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

hec_endpoint_type: HecEndpointType

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

hec_token: Option<String>

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

hec_acknowledgment_timeout_in_seconds: Option<i32>

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.

retry_options: Option<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.

s3_backup_mode: Option<SplunkS3BackupMode>

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.

s3_configuration: Option<S3DestinationConfiguration>

The configuration for the backup Amazon S3 location.

processing_configuration: Option<ProcessingConfiguration>

The data processing configuration.

cloud_watch_logging_options: Option<CloudWatchLoggingOptions>

The Amazon CloudWatch logging options for your Firehose stream.

buffering_hints: Option<SplunkBufferingHints>

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

secrets_manager_configuration: Option<SecretsManagerConfiguration>

The configuration that defines how you access secrets for Splunk.

Implementations

impl SplunkDestinationConfiguration

pub fn hec_endpoint(&self) -> &str

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

pub fn hec_endpoint_type(&self) -> &HecEndpointType

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

pub fn hec_token(&self) -> Option<&str>

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

pub fn hec_acknowledgment_timeout_in_seconds(&self) -> Option<i32>

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.

pub fn retry_options(&self) -> Option<&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.

pub fn s3_backup_mode(&self) -> Option<&SplunkS3BackupMode>

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.

pub fn s3_configuration(&self) -> Option<&S3DestinationConfiguration>

The configuration for the backup Amazon S3 location.

pub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>

The data processing configuration.

pub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>

The Amazon CloudWatch logging options for your Firehose stream.

pub fn buffering_hints(&self) -> Option<&SplunkBufferingHints>

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

pub fn secrets_manager_configuration( &self, ) -> Option<&SecretsManagerConfiguration>

The configuration that defines how you access secrets for Splunk.

impl SplunkDestinationConfiguration

pub fn builder() -> SplunkDestinationConfigurationBuilder

Creates a new builder-style object to manufacture SplunkDestinationConfiguration.

Trait Implementations

impl Clone for SplunkDestinationConfiguration

fn clone(&self) -> SplunkDestinationConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SplunkDestinationConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SplunkDestinationConfiguration

fn eq(&self, other: &SplunkDestinationConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SplunkDestinationConfiguration