ElasticsearchDestinationConfiguration

import type { ElasticsearchDestinationConfiguration } from "https://aws-api.deno.dev/v0.4/services/firehose.ts?docs=full";

Describes the configuration of a destination in Amazon ES.

interface ElasticsearchDestinationConfiguration {

BufferingHints?: ElasticsearchBufferingHints | null;

CloudWatchLoggingOptions?: CloudWatchLoggingOptions | null;

ClusterEndpoint?: string | null;

DomainARN?: string | null;

IndexName: string;

IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | null;

ProcessingConfiguration?: ProcessingConfiguration | null;

RetryOptions?: ElasticsearchRetryOptions | null;

RoleARN: string;

S3BackupMode?: ElasticsearchS3BackupMode | null;

S3Configuration: S3DestinationConfiguration;

TypeName?: string | null;

VpcConfiguration?: VpcConfiguration | null;

}

§Properties

BufferingHints?: ElasticsearchBufferingHints | null

[src]

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

CloudWatchLoggingOptions?: CloudWatchLoggingOptions | null

[src]

The Amazon CloudWatch logging options for your delivery stream.

ClusterEndpoint?: string | null

[src]

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

DomainARN?: string | null

[src]

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.

Specify either ClusterEndpoint or DomainARN.

IndexName: string

[src]

The Elasticsearch index name.

IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | null

[src]

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?: ProcessingConfiguration | null

[src]

The data processing configuration.

RetryOptions?: ElasticsearchRetryOptions | null

[src]

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

RoleARN: string

[src]

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 Amazon Web Services Service Namespaces.

S3BackupMode?: ElasticsearchS3BackupMode | null

[src]

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 AmazonOpenSearchService-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 AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

You can't change this backup mode after you create the delivery stream.

S3Configuration: S3DestinationConfiguration

[src]

The configuration for the backup Amazon S3 location.

TypeName?: string | null

[src]

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.

For Elasticsearch 7.x, don't specify a TypeName.

VpcConfiguration?: VpcConfiguration | null

[src]

The details of the VPC of the Amazon ES destination.