pulumi-aws-native-kotlin/com.pulumi.awsnative.kinesisfirehose.kotlin.inputs/DeliveryStreamElasticsearchDestinationConfigurationArgs

DeliveryStreamElasticsearchDestinationConfigurationArgs

data class DeliveryStreamElasticsearchDestinationConfigurationArgs(val bufferingHints: Output<DeliveryStreamElasticsearchBufferingHintsArgs>? = null, val cloudWatchLoggingOptions: Output<DeliveryStreamCloudWatchLoggingOptionsArgs>? = null, val clusterEndpoint: Output<String>? = null, val documentIdOptions: Output<DeliveryStreamDocumentIdOptionsArgs>? = null, val domainArn: Output<String>? = null, val indexName: Output<String>, val indexRotationPeriod: Output<DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod>? = null, val processingConfiguration: Output<DeliveryStreamProcessingConfigurationArgs>? = null, val retryOptions: Output<DeliveryStreamElasticsearchRetryOptionsArgs>? = null, val roleArn: Output<String>, val s3BackupMode: Output<DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode>? = null, val s3Configuration: Output<DeliveryStreamS3DestinationConfigurationArgs>, val typeName: Output<String>? = null, val vpcConfiguration: Output<DeliveryStreamVpcConfigurationArgs>? = null) : ConvertibleToJava<DeliveryStreamElasticsearchDestinationConfigurationArgs>

Constructors

constructor(bufferingHints: Output<DeliveryStreamElasticsearchBufferingHintsArgs>? = null, cloudWatchLoggingOptions: Output<DeliveryStreamCloudWatchLoggingOptionsArgs>? = null, clusterEndpoint: Output<String>? = null, documentIdOptions: Output<DeliveryStreamDocumentIdOptionsArgs>? = null, domainArn: Output<String>? = null, indexName: Output<String>, indexRotationPeriod: Output<DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod>? = null, processingConfiguration: Output<DeliveryStreamProcessingConfigurationArgs>? = null, retryOptions: Output<DeliveryStreamElasticsearchRetryOptionsArgs>? = null, roleArn: Output<String>, s3BackupMode: Output<DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode>? = null, s3Configuration: Output<DeliveryStreamS3DestinationConfigurationArgs>, typeName: Output<String>? = null, vpcConfiguration: Output<DeliveryStreamVpcConfigurationArgs>? = null)

Properties

Link copied to clipboard
val bufferingHints: Output<DeliveryStreamElasticsearchBufferingHintsArgs>? = null

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Link copied to clipboard
val cloudWatchLoggingOptions: Output<DeliveryStreamCloudWatchLoggingOptionsArgs>? = null

The Amazon CloudWatch Logs logging options for the delivery stream.

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

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Link copied to clipboard
val documentIdOptions: Output<DeliveryStreamDocumentIdOptionsArgs>? = null

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

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

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN . Specify either ClusterEndpoint or DomainARN .

Link copied to clipboard
val indexName: Output<String>

The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.

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

The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .

Link copied to clipboard
val processingConfiguration: Output<DeliveryStreamProcessingConfigurationArgs>? = null

The data processing configuration for the Kinesis Data Firehose delivery stream.

Link copied to clipboard
val retryOptions: Output<DeliveryStreamElasticsearchRetryOptionsArgs>? = null

The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

Link copied to clipboard
val roleArn: Output<String>

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Controlling Access with Amazon Kinesis Data Firehose .

Link copied to clipboard
val s3BackupMode: Output<DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode>? = null

The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Link copied to clipboard
val s3Configuration: Output<DeliveryStreamS3DestinationConfigurationArgs>

The S3 bucket where Kinesis Data Firehose backs up incoming data.

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

The Elasticsearch type name that Amazon ES adds to documents when indexing data.

Link copied to clipboard
val vpcConfiguration: Output<DeliveryStreamVpcConfigurationArgs>? = null

The details of the VPC of the Amazon ES destination.

Functions

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