Class FirehoseDeliveryStreamOpensearchserverlessConfiguration


  • public final class FirehoseDeliveryStreamOpensearchserverlessConfiguration
    extends java.lang.Object
    • Method Detail

      • bufferingInterval

        public java.util.Optional<java.lang.Integer> bufferingInterval()
        Returns:
        Buffer incoming data for the specified period of time, in seconds between 0 to 900, before delivering it to the destination. The default value is 300s.
      • bufferingSize

        public java.util.Optional<java.lang.Integer> bufferingSize()
        Returns:
        Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.
      • collectionEndpoint

        public java.lang.String collectionEndpoint()
        Returns:
        Endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
      • indexName

        public java.lang.String indexName()
        Returns:
        Serverless offering for Amazon OpenSearch Service index name.
      • retryDuration

        public java.util.Optional<java.lang.Integer> retryDuration()
        Returns:
        After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time, in seconds between 0 to 7200, during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.
      • roleArn

        public java.lang.String roleArn()
        Returns:
        ARN of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents. The pattern needs to be `arn:.*`.
      • s3BackupMode

        public java.util.Optional<java.lang.String> s3BackupMode()
        Returns:
        How documents should be delivered to Amazon S3. Valid values are `FailedDocumentsOnly` and `AllDocuments`. Default value is `FailedDocumentsOnly`.