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.

The destination description in Amazon ES.

Inheritance Hierarchy

System.Object
  Amazon.KinesisFirehose.Model.ElasticsearchDestinationDescription

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

Syntax

C# 
public class ElasticsearchDestinationDescription

The ElasticsearchDestinationDescription type exposes the following members

Constructors

NameDescription
Public Method ElasticsearchDestinationDescription()

Properties

NameTypeDescription
Public Property BufferingHints Amazon.KinesisFirehose.Model.ElasticsearchBufferingHints

Gets and sets the property BufferingHints.

The buffering options.

Public Property CloudWatchLoggingOptions Amazon.KinesisFirehose.Model.CloudWatchLoggingOptions

Gets and sets the property CloudWatchLoggingOptions.

The Amazon CloudWatch logging options.

Public Property ClusterEndpoint System.String

Gets and sets the property ClusterEndpoint.

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

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. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

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

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 Amazon ES retry options.

Public Property RoleARN System.String

Gets and sets the property RoleARN.

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Public Property S3BackupMode Amazon.KinesisFirehose.ElasticsearchS3BackupMode

Gets and sets the property S3BackupMode.

The Amazon S3 backup mode.

Public Property S3DestinationDescription Amazon.KinesisFirehose.Model.S3DestinationDescription

Gets and sets the property S3DestinationDescription.

The Amazon S3 destination.

Public Property TypeName System.String

Gets and sets the property TypeName.

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

Public Property VpcConfigurationDescription Amazon.KinesisFirehose.Model.VpcConfigurationDescription

Gets and sets the property VpcConfigurationDescription.

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

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