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

System.Object
  Amazon.KinesisFirehose.Model.ElasticsearchDestinationUpdate

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

Syntax

C#
public class ElasticsearchDestinationUpdate

The ElasticsearchDestinationUpdate 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, 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 ClusterEndpoint System.String

Gets and sets the property ClusterEndpoint.

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

Public Property DocumentIdOptions Amazon.KinesisFirehose.Model.DocumentIdOptions

Gets and sets the property DocumentIdOptions.

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

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

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

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 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 Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services 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, Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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