FirehoseDeliveryStreamElasticsearchConfigurationArgs

data class FirehoseDeliveryStreamElasticsearchConfigurationArgs(val bufferingInterval: Output<Int>? = null, val bufferingSize: Output<Int>? = null, val cloudwatchLoggingOptions: Output<FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptionsArgs>? = null, val clusterEndpoint: Output<String>? = null, val domainArn: Output<String>? = null, val indexName: Output<String>, val indexRotationPeriod: Output<String>? = null, val processingConfiguration: Output<FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationArgs>? = null, val retryDuration: Output<Int>? = null, val roleArn: Output<String>, val s3BackupMode: Output<String>? = null, val s3Configuration: Output<FirehoseDeliveryStreamElasticsearchConfigurationS3ConfigurationArgs>, val typeName: Output<String>? = null, val vpcConfig: Output<FirehoseDeliveryStreamElasticsearchConfigurationVpcConfigArgs>? = null) : ConvertibleToJava<FirehoseDeliveryStreamElasticsearchConfigurationArgs>

Constructors

constructor(bufferingInterval: Output<Int>? = null, bufferingSize: Output<Int>? = null, cloudwatchLoggingOptions: Output<FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptionsArgs>? = null, clusterEndpoint: Output<String>? = null, domainArn: Output<String>? = null, indexName: Output<String>, indexRotationPeriod: Output<String>? = null, processingConfiguration: Output<FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfigurationArgs>? = null, retryDuration: Output<Int>? = null, roleArn: Output<String>, s3BackupMode: Output<String>? = null, s3Configuration: Output<FirehoseDeliveryStreamElasticsearchConfigurationS3ConfigurationArgs>, typeName: Output<String>? = null, vpcConfig: Output<FirehoseDeliveryStreamElasticsearchConfigurationVpcConfigArgs>? = null)

Properties

Link copied to clipboard
val bufferingInterval: Output<Int>? = null

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.

Link copied to clipboard
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.

Link copied to clipboard

The CloudWatch Logging Options for the delivery stream. See cloudwatch_logging_options block below for details.

Link copied to clipboard
val clusterEndpoint: Output<String>? = null

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

Link copied to clipboard
val domainArn: Output<String>? = null

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

Link copied to clipboard
val indexName: Output<String>

The Elasticsearch index name.

Link copied to clipboard
val indexRotationPeriod: Output<String>? = null

The Elasticsearch 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.

Link copied to clipboard

The data processing configuration. See processing_configuration block below for details.

Link copied to clipboard
val retryDuration: Output<Int>? = null

After an initial failure to deliver to Amazon Elasticsearch, 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.

Link copied to clipboard
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 DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig. The pattern needs to be arn:.*.

Link copied to clipboard
val s3BackupMode: Output<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

The S3 Configuration. See s3_configuration block below for details.

Link copied to clipboard
val typeName: Output<String>? = null

The Elasticsearch type name with maximum length of 100 characters.

Link copied to clipboard

The VPC configuration for the delivery stream to connect to Elastic Search associated with the VPC. See vpc_config block below for details.

Functions

Link copied to clipboard
open override fun toJava(): FirehoseDeliveryStreamElasticsearchConfigurationArgs