Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonOpenSearchServerlessDestinationConfigurationProperty

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

Overview

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(index_name:, role_arn:, s3_configuration:, buffering_hints: nil, cloud_watch_logging_options: nil, collection_endpoint: nil, processing_configuration: nil, retry_options: nil, s3_backup_mode: nil, vpc_configuration: nil) ⇒ AmazonOpenSearchServerlessDestinationConfigurationProperty

Returns a new instance of AmazonOpenSearchServerlessDestinationConfigurationProperty.

Parameters:



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 841

def initialize(index_name:, role_arn:, s3_configuration:, buffering_hints: nil, cloud_watch_logging_options: nil, collection_endpoint: nil, processing_configuration: nil, retry_options: nil, s3_backup_mode: nil, vpc_configuration: nil)
  @index_name = index_name
  Jsii::Type.check_type(@index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @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::AmazonOpenSearchServerlessBufferingHintsProperty.new(**buffering_hints.transform_keys(&:to_sym)) : buffering_hints
  Jsii::Type.check_type(@buffering_hints, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQW1hem9uT3BlblNlYXJjaFNlcnZlcmxlc3NCdWZmZXJpbmdIaW50c1Byb3BlcnR5In1dfX0=")), "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?
  @collection_endpoint = collection_endpoint
  Jsii::Type.check_type(@collection_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collectionEndpoint") unless @collection_endpoint.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::AmazonOpenSearchServerlessRetryOptionsProperty.new(**retry_options.transform_keys(&:to_sym)) : retry_options
  Jsii::Type.check_type(@retry_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQW1hem9uT3BlblNlYXJjaFNlcnZlcmxlc3NSZXRyeU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "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?
  @vpc_configuration = vpc_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::VPCConfigurationProperty.new(**vpc_configuration.transform_keys(&:to_sym)) : vpc_configuration
  Jsii::Type.check_type(@vpc_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uVnBjQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "vpcConfiguration") unless @vpc_configuration.nil?
end

Instance Attribute Details

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

The buffering options.

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

Returns:

See Also:



883
884
885
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 883

def buffering_hints
  @buffering_hints
end

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

Returns:

See Also:



886
887
888
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 886

def cloud_watch_logging_options
  @cloud_watch_logging_options
end

#collection_endpoint ⇒ String? (readonly)

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Returns:

  • (String, nil)

See Also:



891
892
893
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 891

def collection_endpoint
  @collection_endpoint
end

#index_name ⇒ String (readonly)

The Serverless offering for Amazon OpenSearch Service index name.

Returns:

  • (String)

See Also:



868
869
870
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 868

def index_name
  @index_name
end

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

Returns:

See Also:



894
895
896
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 894

def processing_configuration
  @processing_configuration
end

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

The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

The default value is 300 (5 minutes).

Returns:

See Also:



901
902
903
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 901

def retry_options
  @retry_options
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

Returns:

  • (String)

See Also:



873
874
875
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 873

def role_arn
  @role_arn
end

#s3_backup_mode ⇒ String? (readonly)

Defines how documents should be delivered to Amazon S3.

When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

Returns:

  • (String, nil)

See Also:



908
909
910
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 908

def s3_backup_mode
  @s3_backup_mode
end

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

Returns:

See Also:



876
877
878
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 876

def s3_configuration
  @s3_configuration
end

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

Returns:

See Also:



911
912
913
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 911

def vpc_configuration
  @vpc_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 913

def self.jsii_properties
  {
    :index_name => "indexName",
    :role_arn => "roleArn",
    :s3_configuration => "s3Configuration",
    :buffering_hints => "bufferingHints",
    :cloud_watch_logging_options => "cloudWatchLoggingOptions",
    :collection_endpoint => "collectionEndpoint",
    :processing_configuration => "processingConfiguration",
    :retry_options => "retryOptions",
    :s3_backup_mode => "s3BackupMode",
    :vpc_configuration => "vpcConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 928

def to_jsii
  result = {}
  result.merge!({
    "indexName" => @index_name,
    "roleArn" => @role_arn,
    "s3Configuration" => @s3_configuration,
    "bufferingHints" => @buffering_hints,
    "cloudWatchLoggingOptions" => @cloud_watch_logging_options,
    "collectionEndpoint" => @collection_endpoint,
    "processingConfiguration" => @processing_configuration,
    "retryOptions" => @retry_options,
    "s3BackupMode" => @s3_backup_mode,
    "vpcConfiguration" => @vpc_configuration,
  })
  result.compact
end