Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.DocumentIdOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.DocumentIdOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.DocumentIdOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Indicates the method for setting up document ID.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 DocumentIdOptionsProperty documentIdOptionsProperty = DocumentIdOptionsProperty.builder()
         .defaultDocumentIdFormat("defaultDocumentIdFormat")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStream.DocumentIdOptionsProperty.Builder	A builder for CfnDeliveryStream.DocumentIdOptionsProperty
static final class	CfnDeliveryStream.DocumentIdOptionsProperty.Jsii$Proxy	An implementation for CfnDeliveryStream.DocumentIdOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.DocumentIdOptionsProperty.Builder	builder()
String	getDefaultDocumentIdFormat()	When the FIREHOSE_DEFAULT option is chosen, Kinesis Data Firehose generates a unique document ID for each record based on a unique internal identifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultDocumentIdFormat

@Stability(Stable)
@NotNull
String getDefaultDocumentIdFormat()

When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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, Kinesis Data 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.

See Also:

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

builder

@Stability(Stable)
static CfnDeliveryStream.DocumentIdOptionsProperty.Builder builder()

Returns:

a CfnDeliveryStream.DocumentIdOptionsProperty.Builder of CfnDeliveryStream.DocumentIdOptionsProperty