ElasticsearchDestinationUpdate

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

Describes an update for a destination in Amazon ES.

interface ElasticsearchDestinationUpdate {

BufferingHints?: ElasticsearchBufferingHints | null;

CloudWatchLoggingOptions?: CloudWatchLoggingOptions | null;

ClusterEndpoint?: string | null;

DomainARN?: string | null;

IndexName?: string | null;

IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | null;

ProcessingConfiguration?: ProcessingConfiguration | null;

RetryOptions?: ElasticsearchRetryOptions | null;

RoleARN?: string | null;

S3Update?: S3DestinationUpdate | null;

TypeName?: string | null;

}

§Properties

BufferingHints?: ElasticsearchBufferingHints | null

[src]

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

CloudWatchLoggingOptions?: CloudWatchLoggingOptions | null

[src]

The 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 IAM 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 | null

[src]

The Elasticsearch index name.

IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | null

[src]

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. 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 | null

[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.

S3Update?: S3DestinationUpdate | null

[src]

The Amazon S3 destination.

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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.