Class: Aws::Firehose::Types::SplunkDestinationUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::SplunkDestinationUpdate
- Defined in:
- gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb
Overview
When making an API call, you may pass SplunkDestinationUpdate data as a hash:
{
hec_endpoint: "HECEndpoint",
hec_endpoint_type: "Raw", # accepts Raw, Event
hec_token: "HECToken",
hec_acknowledgment_timeout_in_seconds: 1,
retry_options: {
duration_in_seconds: 1,
},
s3_backup_mode: "FailedEventsOnly", # accepts FailedEventsOnly, AllEvents
s3_update: {
role_arn: "RoleARN",
bucket_arn: "BucketARN",
prefix: "Prefix",
error_output_prefix: "ErrorOutputPrefix",
buffering_hints: {
size_in_m_bs: 1,
interval_in_seconds: 1,
},
compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
encryption_configuration: {
no_encryption_config: "NoEncryption", # accepts NoEncryption
kms_encryption_config: {
awskms_key_arn: "AWSKMSKeyARN", # required
},
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
},
processing_configuration: {
enabled: false,
processors: [
{
type: "Lambda", # required, accepts Lambda
parameters: [
{
parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds
parameter_value: "ProcessorParameterValue", # required
},
],
},
],
},
cloud_watch_logging_options: {
enabled: false,
log_group_name: "LogGroupName",
log_stream_name: "LogStreamName",
},
}
Describes an update for a destination in Splunk.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
-
#hec_acknowledgment_timeout_in_seconds ⇒ Integer
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data.
-
#hec_endpoint ⇒ String
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
-
#hec_endpoint_type ⇒ String
This type can be either "Raw" or "Event.".
-
#hec_token ⇒ String
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
-
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
-
#retry_options ⇒ Types::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 ⇒ String
Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3.
-
#s3_update ⇒ Types::S3DestinationUpdate
Your update to the configuration of the backup Amazon S3 location.
Instance Attribute Details
#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#hec_acknowledgment_timeout_in_seconds ⇒ Integer
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends 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.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#hec_endpoint ⇒ String
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#hec_endpoint_type ⇒ String
This type can be either "Raw" or "Event."
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#hec_token ⇒ String
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#processing_configuration ⇒ Types::ProcessingConfiguration
The data processing configuration.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#retry_options ⇒ Types::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.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#s3_backup_mode ⇒ String
Specifies how you want Kinesis Data Firehose to back up documents 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 AllEvents
, Kinesis Data 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
.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |
#s3_update ⇒ Types::S3DestinationUpdate
Your update to the configuration of the backup Amazon S3 location.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 |
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4846 class SplunkDestinationUpdate < Struct.new( :hec_endpoint, :hec_endpoint_type, :hec_token, :hec_acknowledgment_timeout_in_seconds, :retry_options, :s3_backup_mode, :s3_update, :processing_configuration, :cloud_watch_logging_options) SENSITIVE = [] include Aws::Structure end |