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 the configuration of a destination in Amazon ES.

Inheritance Hierarchy

System.Object
  Amazon.KinesisFirehose.Model.ElasticsearchDestinationConfiguration

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

Syntax

C#
public class ElasticsearchDestinationConfiguration

The ElasticsearchDestinationConfiguration type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BufferingHints Amazon.KinesisFirehose.Model.ElasticsearchBufferingHints

Gets and sets the property BufferingHints.

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints 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 role specified in RoleARN.

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 the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. The 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 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 ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.

Public Property S3BackupMode Amazon.KinesisFirehose.ElasticsearchS3BackupMode

Gets and sets the property S3BackupMode.

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis 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 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 Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

Public Property S3Configuration Amazon.KinesisFirehose.Model.S3DestinationConfiguration

Gets and sets the property S3Configuration.

The configuration for the backup Amazon S3 location.

Public Property TypeName System.String

Gets and sets the property TypeName.

The Elasticsearch type name.

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

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