pulumi-aws-kotlin/com.pulumi.aws.kinesis.kotlin.inputs/FirehoseDeliveryStreamOpensearchConfigurationArgs

FirehoseDeliveryStreamOpensearchConfigurationArgs

data class FirehoseDeliveryStreamOpensearchConfigurationArgs(val bufferingInterval: Output<Int>? = null, val bufferingSize: Output<Int>? = null, val cloudwatchLoggingOptions: Output<FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptionsArgs>? = null, val clusterEndpoint: Output<String>? = null, val domainArn: Output<String>? = null, val indexName: Output<String>, val indexRotationPeriod: Output<String>? = null, val processingConfiguration: Output<FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationArgs>? = null, val retryDuration: Output<Int>? = null, val roleArn: Output<String>, val s3BackupMode: Output<String>? = null, val s3Configuration: Output<FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationArgs>, val typeName: Output<String>? = null, val vpcConfig: Output<FirehoseDeliveryStreamOpensearchConfigurationVpcConfigArgs>? = null) : ConvertibleToJava<FirehoseDeliveryStreamOpensearchConfigurationArgs>

Constructors

fun FirehoseDeliveryStreamOpensearchConfigurationArgs(bufferingInterval: Output<Int>? = null, bufferingSize: Output<Int>? = null, cloudwatchLoggingOptions: Output<FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptionsArgs>? = null, clusterEndpoint: Output<String>? = null, domainArn: Output<String>? = null, indexName: Output<String>, indexRotationPeriod: Output<String>? = null, processingConfiguration: Output<FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationArgs>? = null, retryDuration: Output<Int>? = null, roleArn: Output<String>, s3BackupMode: Output<String>? = null, s3Configuration: Output<FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationArgs>, typeName: Output<String>? = null, vpcConfig: Output<FirehoseDeliveryStreamOpensearchConfigurationVpcConfigArgs>? = null)

Functions

toJava

open override fun toJava(): FirehoseDeliveryStreamOpensearchConfigurationArgs

Properties

bufferingInterval

val bufferingInterval: Output<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.

bufferingSize

val bufferingSize: Output<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.

cloudwatchLoggingOptions

val cloudwatchLoggingOptions: Output<FirehoseDeliveryStreamOpensearchConfigurationCloudwatchLoggingOptionsArgs>? = null

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

clusterEndpoint

val clusterEndpoint: Output<String>? = null

The endpoint to use when communicating with the cluster. Conflicts with domain_arn.

domainArn

val domainArn: Output<String>? = null

The ARN of the Amazon ES domain. The pattern needs to be arn:.*. Conflicts with cluster_endpoint.

indexName

val indexName: Output<String>

The OpenSearch index name.

indexRotationPeriod

val indexRotationPeriod: Output<String>? = null

The OpenSearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. Valid values are NoRotation, OneHour, OneDay, OneWeek, and OneMonth. The default value is OneDay.

processingConfiguration

val processingConfiguration: Output<FirehoseDeliveryStreamOpensearchConfigurationProcessingConfigurationArgs>? = null

The data processing configuration. More details are given below.

retryDuration

val retryDuration: Output<Int>? = null

After an initial failure to deliver to Amazon OpenSearch, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts 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

val roleArn: Output<String>

The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. The IAM role must have permission for DescribeDomain, DescribeDomains, and DescribeDomainConfig. The pattern needs to be arn:.*.

s3BackupMode

val s3BackupMode: Output<String>? = null

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

s3Configuration

val s3Configuration: Output<FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationArgs>

The S3 Configuration. See s3_configuration for more details.

typeName

val typeName: Output<String>? = null

The Elasticsearch type name with maximum length of 100 characters. Types are deprecated in OpenSearch_1.1. TypeName must be empty.

vpcConfig

val vpcConfig: Output<FirehoseDeliveryStreamOpensearchConfigurationVpcConfigArgs>? = null

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