ElasticsearchDestinationConfiguration class

Describes the configuration of a destination in Amazon ES.

Constructors

ElasticsearchDestinationConfiguration({required String indexName, required String roleARN, required S3DestinationConfiguration s3Configuration, ElasticsearchBufferingHints? bufferingHints, CloudWatchLoggingOptions? cloudWatchLoggingOptions, String? clusterEndpoint, String? domainARN, ElasticsearchIndexRotationPeriod? indexRotationPeriod, ProcessingConfiguration? processingConfiguration, ElasticsearchRetryOptions? retryOptions, ElasticsearchS3BackupMode? s3BackupMode, String? typeName, VpcConfiguration? vpcConfiguration})

Properties

bufferingHints → ElasticsearchBufferingHints?

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

final

cloudWatchLoggingOptions → CloudWatchLoggingOptions?

The Amazon CloudWatch logging options for your delivery stream.

final

clusterEndpoint → String?

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

final

domainARN → String?

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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

final

hashCode → int

The hash code for this object.

no setter, inherited

indexName → String

The Elasticsearch index name.

final

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.

final

processingConfiguration → ProcessingConfiguration?

The data processing configuration.

final

retryOptions → ElasticsearchRetryOptions?

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

final

roleARN → 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 Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

s3BackupMode → ElasticsearchS3BackupMode?

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

final

s3Configuration → S3DestinationConfiguration

The configuration for the backup Amazon S3 location.

final

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, Kinesis Data Firehose returns an error during run time.

final

vpcConfiguration → VpcConfiguration?

The details of the VPC of the Amazon ES destination.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited