firehose/aws.sdk.kotlin.services.firehose.model/ElasticsearchDestinationDescription

ElasticsearchDestinationDescription

class ElasticsearchDestinationDescription

The destination description in Amazon OpenSearch Service.

Types

Builder

class Builder

Companion

object Companion

Properties

bufferingHints

val bufferingHints: ElasticsearchBufferingHints?

The buffering options.

cloudWatchLoggingOptions

val cloudWatchLoggingOptions: CloudWatchLoggingOptions?

The Amazon CloudWatch logging options.

clusterEndpoint

val clusterEndpoint: String?

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

documentIdOptions

val documentIdOptions: DocumentIdOptions?

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

domainArn

val domainArn: String?

The ARN of the Amazon OpenSearch Service domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

indexName

val indexName: String?

The Elasticsearch index name.

indexRotationPeriod

val indexRotationPeriod: ElasticsearchIndexRotationPeriod?

The Elasticsearch index rotation period

processingConfiguration

val processingConfiguration: ProcessingConfiguration?

The data processing configuration.

retryOptions

val retryOptions: ElasticsearchRetryOptions?

The Amazon OpenSearch Service retry options.

roleArn

val roleArn: String?

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3BackupMode

val s3BackupMode: ElasticsearchS3BackupMode?

The Amazon S3 backup mode.

s3DestinationDescription

val s3DestinationDescription: S3DestinationDescription?

The Amazon S3 destination.

typeName

val typeName: String?

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

vpcConfigurationDescription

val vpcConfigurationDescription: VpcConfigurationDescription?

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Functions

copy

inline fun copy(block: ElasticsearchDestinationDescription.Builder.() -> Unit = {}): ElasticsearchDestinationDescription

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String