AmazonopensearchserviceDestinationUpdate

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

Describes an update for a destination in Amazon OpenSearch Service.

interface AmazonopensearchserviceDestinationUpdate {

BufferingHints?: AmazonopensearchserviceBufferingHints | null;

CloudWatchLoggingOptions?: CloudWatchLoggingOptions | null;

ClusterEndpoint?: string | null;

DomainARN?: string | null;

IndexName?: string | null;

IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | null;

ProcessingConfiguration?: ProcessingConfiguration | null;

RetryOptions?: AmazonopensearchserviceRetryOptions | null;

RoleARN?: string | null;

S3Update?: S3DestinationUpdate | null;

TypeName?: string | null;

}

§Properties

BufferingHints?: AmazonopensearchserviceBufferingHints | null

[src]

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

CloudWatchLoggingOptions?: CloudWatchLoggingOptions | null

[src]

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 OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

IndexName?: string | null

[src]

The Amazon OpenSearch Service index name.

IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | null

[src]

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

ProcessingConfiguration?: ProcessingConfiguration | null

[src]

RetryOptions?: AmazonopensearchserviceRetryOptions | null

[src]

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. 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 OpenSearch Service Configuration API and for indexing documents.

S3Update?: S3DestinationUpdate | null

[src]

TypeName?: string | null

[src]

The Amazon OpenSearch Service 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.