firehose/aws.sdk.kotlin.services.firehose.model/ElasticsearchDestinationConfiguration/Builder

Builder

class Builder

Properties

bufferingHints

var bufferingHints: ElasticsearchBufferingHints?

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

cloudWatchLoggingOptions

var cloudWatchLoggingOptions: CloudWatchLoggingOptions?

The Amazon CloudWatch logging options for your delivery stream.

clusterEndpoint

var clusterEndpoint: String?

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

documentIdOptions

var 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

var domainArn: String?

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

indexName

var indexName: String?

The Elasticsearch index name.

indexRotationPeriod

var indexRotationPeriod: ElasticsearchIndexRotationPeriod?

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

processingConfiguration

var processingConfiguration: ProcessingConfiguration?

The data processing configuration.

retryOptions

var retryOptions: ElasticsearchRetryOptions?

The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

roleArn

var roleArn: String?

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3BackupMode

var s3BackupMode: ElasticsearchS3BackupMode?

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

s3Configuration

var s3Configuration: S3DestinationConfiguration?

The configuration for the backup Amazon S3 location.

typeName

var typeName: String?

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.

vpcConfiguration

var vpcConfiguration: VpcConfiguration?

The details of the VPC of the Amazon destination.