AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes an update for a destination in Amazon ES.

Inheritance Hierarchy


Namespace: Amazon.KinesisFirehose.Model
Assembly: AWSSDK.KinesisFirehose.dll
Version: 3.x.y.z


public class ElasticsearchDestinationUpdate

The ElasticsearchDestinationUpdate type exposes the following members



Public Property BufferingHints Amazon.KinesisFirehose.Model.ElasticsearchBufferingHints

Gets and sets the property BufferingHints.

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

Public Property CloudWatchLoggingOptions Amazon.KinesisFirehose.Model.CloudWatchLoggingOptions

Gets and sets the property CloudWatchLoggingOptions.

The CloudWatch logging options for your delivery stream.

Public Property DomainARN System.String

Gets and sets the property DomainARN.

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Public Property IndexName System.String

Gets and sets the property IndexName.

The Elasticsearch index name.

Public Property IndexRotationPeriod Amazon.KinesisFirehose.ElasticsearchIndexRotationPeriod

Gets and sets the property IndexRotationPeriod.

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

Public Property ProcessingConfiguration Amazon.KinesisFirehose.Model.ProcessingConfiguration

Gets and sets the property ProcessingConfiguration.

The data processing configuration.

Public Property RetryOptions Amazon.KinesisFirehose.Model.ElasticsearchRetryOptions

Gets and sets the property RetryOptions.

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

Public Property RoleARN System.String

Gets and sets the property RoleARN.

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.

Public Property S3Update Amazon.KinesisFirehose.Model.S3DestinationUpdate

Gets and sets the property S3Update.

The Amazon S3 destination.

Public Property TypeName System.String

Gets and sets the property TypeName.

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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone