Struct aws_sdk_firehose::model::SplunkDestinationDescription

#[non_exhaustive]
pub struct SplunkDestinationDescription {
    pub hec_endpoint: Option<String>,
    pub hec_endpoint_type: Option<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_destination_description: Option<S3DestinationDescription>,
    pub processing_configuration: Option<ProcessingConfiguration>,
    pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
}

Describes 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: Option<String>

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

hec_endpoint_type: Option<HecEndpointType>

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

hec_token: Option<String>

A GUID 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 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.

retry_options: Option<SplunkRetryOptions>

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.

s3_backup_mode: Option<SplunkS3BackupMode>

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

s3_destination_description: Option<S3DestinationDescription>

The Amazon S3 destination.>

processing_configuration: Option<ProcessingConfiguration>

The data processing configuration.

cloud_watch_logging_options: Option<CloudWatchLoggingOptions>

The Amazon CloudWatch logging options for your delivery stream.

Implementations

impl SplunkDestinationDescription

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

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

pub fn hec_endpoint_type(&self) -> Option<&HecEndpointType>

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

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

A GUID 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 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.

pub fn retry_options(&self) -> Option<&SplunkRetryOptions>

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.

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

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

pub fn s3_destination_description(&self) -> Option<&S3DestinationDescription>

The Amazon S3 destination.>

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 delivery stream.

impl SplunkDestinationDescription

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SplunkDestinationDescription

Trait Implementations

impl Clone for SplunkDestinationDescription

fn clone(&self) -> SplunkDestinationDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SplunkDestinationDescription

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

Formats the value using the given formatter.

impl PartialEq<SplunkDestinationDescription> for SplunkDestinationDescription

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for SplunkDestinationDescription