Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::SplunkDestinationConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_firehose/cfn_delivery_stream.rb

Overview

The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hec_endpoint:, hec_endpoint_type:, s3_configuration:, buffering_hints: nil, cloud_watch_logging_options: nil, hec_acknowledgment_timeout_in_seconds: nil, hec_token: nil, processing_configuration: nil, retry_options: nil, s3_backup_mode: nil, secrets_manager_configuration: nil) ⇒ SplunkDestinationConfigurationProperty

Returns a new instance of SplunkDestinationConfigurationProperty.

Parameters:



4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4965

def initialize(hec_endpoint:, hec_endpoint_type:, s3_configuration:, buffering_hints: nil, cloud_watch_logging_options: nil, hec_acknowledgment_timeout_in_seconds: nil, hec_token: nil, processing_configuration: nil, retry_options: nil, s3_backup_mode: nil, secrets_manager_configuration: nil)
  @hec_endpoint = hec_endpoint
  Jsii::Type.check_type(@hec_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hecEndpoint")
  @hec_endpoint_type = hec_endpoint_type
  Jsii::Type.check_type(@hec_endpoint_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hecEndpointType")
  @s3_configuration = s3_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::S3DestinationConfigurationProperty.new(**s3_configuration.transform_keys(&:to_sym)) : s3_configuration
  Jsii::Type.check_type(@s3_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uUzNEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "s3Configuration")
  @buffering_hints = buffering_hints.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SplunkBufferingHintsProperty.new(**buffering_hints.transform_keys(&:to_sym)) : buffering_hints
  Jsii::Type.check_type(@buffering_hints, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU3BsdW5rQnVmZmVyaW5nSGludHNQcm9wZXJ0eSJ9XX19")), "bufferingHints") unless @buffering_hints.nil?
  @cloud_watch_logging_options = cloud_watch_logging_options.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::CloudWatchLoggingOptionsProperty.new(**cloud_watch_logging_options.transform_keys(&:to_sym)) : cloud_watch_logging_options
  Jsii::Type.check_type(@cloud_watch_logging_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQ2xvdWRXYXRjaExvZ2dpbmdPcHRpb25zUHJvcGVydHkifV19fQ==")), "cloudWatchLoggingOptions") unless @cloud_watch_logging_options.nil?
  @hec_acknowledgment_timeout_in_seconds = hec_acknowledgment_timeout_in_seconds
  Jsii::Type.check_type(@hec_acknowledgment_timeout_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "hecAcknowledgmentTimeoutInSeconds") unless @hec_acknowledgment_timeout_in_seconds.nil?
  @hec_token = hec_token
  Jsii::Type.check_type(@hec_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hecToken") unless @hec_token.nil?
  @processing_configuration = processing_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::ProcessingConfigurationProperty.new(**processing_configuration.transform_keys(&:to_sym)) : processing_configuration
  Jsii::Type.check_type(@processing_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uUHJvY2Vzc2luZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "processingConfiguration") unless @processing_configuration.nil?
  @retry_options = retry_options.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SplunkRetryOptionsProperty.new(**retry_options.transform_keys(&:to_sym)) : retry_options
  Jsii::Type.check_type(@retry_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU3BsdW5rUmV0cnlPcHRpb25zUHJvcGVydHkifV19fQ==")), "retryOptions") unless @retry_options.nil?
  @s3_backup_mode = s3_backup_mode
  Jsii::Type.check_type(@s3_backup_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BackupMode") unless @s3_backup_mode.nil?
  @secrets_manager_configuration = secrets_manager_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SecretsManagerConfigurationProperty.new(**secrets_manager_configuration.transform_keys(&:to_sym)) : secrets_manager_configuration
  Jsii::Type.check_type(@secrets_manager_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU2VjcmV0c01hbmFnZXJDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "secretsManagerConfiguration") unless @secrets_manager_configuration.nil?
end

Instance Attribute Details

#buffering_hints ⇒ AWSCDK::IResolvable, ... (readonly)

The buffering options.

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

Returns:

See Also:



5011
5012
5013
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5011

def buffering_hints
  @buffering_hints
end

#cloud_watch_logging_options ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon CloudWatch logging options for your Firehose stream.

Returns:

See Also:



5016
5017
5018
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5016

def cloud_watch_logging_options
  @cloud_watch_logging_options
end

#hec_acknowledgment_timeout_in_seconds ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



5023
5024
5025
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5023

def hec_acknowledgment_timeout_in_seconds
  @hec_acknowledgment_timeout_in_seconds
end

#hec_endpoint ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



4994
4995
4996
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4994

def hec_endpoint
  @hec_endpoint
end

#hec_endpoint_type ⇒ String (readonly)

This type can be either Raw or Event .

Returns:

  • (String)

See Also:



4999
5000
5001
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4999

def hec_endpoint_type
  @hec_endpoint_type
end

#hec_token ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



5028
5029
5030
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5028

def hec_token
  @hec_token
end

#processing_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The data processing configuration.

Returns:

See Also:



5033
5034
5035
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5033

def processing_configuration
  @processing_configuration
end

#retry_options ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



5038
5039
5040
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5038

def retry_options
  @retry_options
end

#s3_backup_mode ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



5047
5048
5049
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5047

def s3_backup_mode
  @s3_backup_mode
end

#s3_configuration ⇒ AWSCDK::IResolvable, AWSCDK::KinesisFirehose::CfnDeliveryStream::S3DestinationConfigurationProperty (readonly)

The configuration for the backup Amazon S3 location.

Returns:

See Also:



5004
5005
5006
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5004

def s3_configuration
  @s3_configuration
end

#secrets_manager_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration that defines how you access secrets for Splunk.

Returns:

See Also:



5052
5053
5054
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5052

def secrets_manager_configuration
  @secrets_manager_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5054

def self.jsii_properties
  {
    :hec_endpoint => "hecEndpoint",
    :hec_endpoint_type => "hecEndpointType",
    :s3_configuration => "s3Configuration",
    :buffering_hints => "bufferingHints",
    :cloud_watch_logging_options => "cloudWatchLoggingOptions",
    :hec_acknowledgment_timeout_in_seconds => "hecAcknowledgmentTimeoutInSeconds",
    :hec_token => "hecToken",
    :processing_configuration => "processingConfiguration",
    :retry_options => "retryOptions",
    :s3_backup_mode => "s3BackupMode",
    :secrets_manager_configuration => "secretsManagerConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 5070

def to_jsii
  result = {}
  result.merge!({
    "hecEndpoint" => @hec_endpoint,
    "hecEndpointType" => @hec_endpoint_type,
    "s3Configuration" => @s3_configuration,
    "bufferingHints" => @buffering_hints,
    "cloudWatchLoggingOptions" => @cloud_watch_logging_options,
    "hecAcknowledgmentTimeoutInSeconds" => @hec_acknowledgment_timeout_in_seconds,
    "hecToken" => @hec_token,
    "processingConfiguration" => @processing_configuration,
    "retryOptions" => @retry_options,
    "s3BackupMode" => @s3_backup_mode,
    "secretsManagerConfiguration" => @secrets_manager_configuration,
  })
  result.compact
end