Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::DocumentIdOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::KinesisFirehose::CfnDeliveryStream::DocumentIdOptionsProperty

Defined in:

kinesis_firehose/cfn_delivery_stream.rb

Overview

Indicates the method for setting up document ID.

The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-documentidoptions.html

Instance Attribute Summary

• #default_document_id_format ⇒ String readonly

  When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(default_document_id_format:) ⇒ DocumentIdOptionsProperty constructor

  A new instance of DocumentIdOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(default_document_id_format:) ⇒ DocumentIdOptionsProperty

Returns a new instance of DocumentIdOptionsProperty.

Parameters:

• default_document_id_format (String) —

  When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier.

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2149

def initialize(default_document_id_format:)
  @default_document_id_format = default_document_id_format
  Jsii::Type.check_type(@default_document_id_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultDocumentIdFormat")
end

Instance Attribute Details

#default_document_id_format ⇒ String (readonly)

When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier.

The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-documentidoptions.html#cfn-kinesisfirehose-deliverystream-documentidoptions-defaultdocumentidformat

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2162

def default_document_id_format
  @default_document_id_format
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2164

def self.jsii_properties
  {
    :default_document_id_format => "defaultDocumentIdFormat",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2170

def to_jsii
  result = {}
  result.merge!({
    "defaultDocumentIdFormat" => @default_document_id_format,
  })
  result.compact
end