Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.DocumentIdOptionsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.DocumentIdOptionsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeliveryStream.DocumentIdOptionsProperty>

Enclosing interface:

CfnDeliveryStream.DocumentIdOptionsProperty

@Stability(Stable)
public static final class CfnDeliveryStream.DocumentIdOptionsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStream.DocumentIdOptionsProperty>

A builder for CfnDeliveryStream.DocumentIdOptionsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeliveryStream.DocumentIdOptionsProperty	build()	Builds the configured instance.
CfnDeliveryStream.DocumentIdOptionsProperty.Builder	defaultDocumentIdFormat(String defaultDocumentIdFormat)	Sets the value of CfnDeliveryStream.DocumentIdOptionsProperty.getDefaultDocumentIdFormat()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

defaultDocumentIdFormat

@Stability(Stable)
public CfnDeliveryStream.DocumentIdOptionsProperty.Builder defaultDocumentIdFormat(String defaultDocumentIdFormat)

Sets the value of CfnDeliveryStream.DocumentIdOptionsProperty.getDefaultDocumentIdFormat()

Parameters:

defaultDocumentIdFormat - When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. This parameter is required. 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:

this

build

@Stability(Stable)
public CfnDeliveryStream.DocumentIdOptionsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDeliveryStream.DocumentIdOptionsProperty>

Returns:

a new instance of CfnDeliveryStream.DocumentIdOptionsProperty

Throws:

NullPointerException - if any required attribute was not provided