pulumi-aws-kotlin/com.pulumi.aws.kinesis.kotlin.outputs/FirehoseDeliveryStreamOpensearchserverlessConfiguration

FirehoseDeliveryStreamOpensearchserverlessConfiguration

data class FirehoseDeliveryStreamOpensearchserverlessConfiguration(val bufferingInterval: Int? = null, val bufferingSize: Int? = null, val cloudwatchLoggingOptions: FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions? = null, val collectionEndpoint: String, val indexName: String, val processingConfiguration: FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration? = null, val retryDuration: Int? = null, val roleArn: String, val s3BackupMode: String? = null, val s3Configuration: FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration, val vpcConfig: FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig? = null)

Constructors

fun FirehoseDeliveryStreamOpensearchserverlessConfiguration(bufferingInterval: Int? = null, bufferingSize: Int? = null, cloudwatchLoggingOptions: FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions? = null, collectionEndpoint: String, indexName: String, processingConfiguration: FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration? = null, retryDuration: Int? = null, roleArn: String, s3BackupMode: String? = null, s3Configuration: FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration, vpcConfig: FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val bufferingInterval: Int? = null

Buffer incoming data for the specified period of time, in seconds between 60 to 900, before delivering it to the destination. The default value is 300s.

Link copied to clipboard
val bufferingSize: Int? = null

Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.

Link copied to clipboard
val cloudwatchLoggingOptions: FirehoseDeliveryStreamOpensearchserverlessConfigurationCloudwatchLoggingOptions? = null

The CloudWatch Logging Options for the delivery stream. More details are given below

Link copied to clipboard
val collectionEndpoint: String

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Link copied to clipboard
val indexName: String

The Serverless offering for Amazon OpenSearch Service index name.

Link copied to clipboard
val processingConfiguration: FirehoseDeliveryStreamOpensearchserverlessConfigurationProcessingConfiguration? = null

The data processing configuration. More details are given below.

Link copied to clipboard
val retryDuration: Int? = null

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.

Link copied to clipboard
val roleArn: String

The Amazon Resource Name (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:.*.

Link copied to clipboard
val s3BackupMode: String? = null

Defines how documents should be delivered to Amazon S3. Valid values are FailedDocumentsOnly and AllDocuments. Default value is FailedDocumentsOnly.

Link copied to clipboard
val s3Configuration: FirehoseDeliveryStreamOpensearchserverlessConfigurationS3Configuration

The S3 Configuration. See s3_configuration for more details.

Link copied to clipboard
val vpcConfig: FirehoseDeliveryStreamOpensearchserverlessConfigurationVpcConfig? = null

The VPC configuration for the delivery stream to connect to OpenSearch Serverless associated with the VPC. More details are given below