Class CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose.CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty>
- Enclosing interface:
CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty
@Stability(Stable)
public static final class CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty>
A builder for
CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.defaultDocumentIdFormat(String defaultDocumentIdFormat)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
defaultDocumentIdFormat
@Stability(Stable) public CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty.Builder defaultDocumentIdFormat(String defaultDocumentIdFormat) Sets the value ofCfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty.getDefaultDocumentIdFormat()- Parameters:
defaultDocumentIdFormat- When theFIREHOSE_DEFAULToption 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_IDoption 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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty>- Returns:
- a new instance of
CfnDeliveryStreamPropsMixin.DocumentIdOptionsProperty - Throws:
NullPointerException- if any required attribute was not provided
-