Struct rusoto_firehose::ElasticsearchDestinationConfiguration

pub struct ElasticsearchDestinationConfiguration {

    pub buffering_hints: Option<ElasticsearchBufferingHints>,
    pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
    pub cluster_endpoint: Option<String>,
    pub domain_arn: Option<String>,
    pub index_name: String,
    pub index_rotation_period: Option<String>,
    pub processing_configuration: Option<ProcessingConfiguration>,
    pub retry_options: Option<ElasticsearchRetryOptions>,
    pub role_arn: String,
    pub s3_backup_mode: Option<String>,
    pub s3_configuration: S3DestinationConfiguration,
    pub type_name: Option<String>,
    pub vpc_configuration: Option<VpcConfiguration>,
}

Describes the configuration of a destination in Amazon ES.

Fields

buffering_hints: Option<ElasticsearchBufferingHints>

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

cloud_watch_logging_options: Option<CloudWatchLoggingOptions>

The Amazon CloudWatch logging options for your delivery stream.

cluster_endpoint: Option<String>

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

domain_arn: Option<String>

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

Specify either ClusterEndpoint or DomainARN.

index_name: String

The Elasticsearch index name.

index_rotation_period: Option<String>

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

processing_configuration: Option<ProcessingConfiguration>

The data processing configuration.

retry_options: Option<ElasticsearchRetryOptions>

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

role_arn: String

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.

s3_backup_mode: Option<String>

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

You can't change this backup mode after you create the delivery stream.

s3_configuration: S3DestinationConfiguration

The configuration for the backup Amazon S3 location.

type_name: Option<String>

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

For Elasticsearch 7.x, don't specify a TypeName.

vpc_configuration: Option<VpcConfiguration>

The details of the VPC of the Amazon ES destination.

Trait Implementations

impl Clone for ElasticsearchDestinationConfiguration

fn clone(&self) -> ElasticsearchDestinationConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ElasticsearchDestinationConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ElasticsearchDestinationConfiguration

fn default() -> ElasticsearchDestinationConfiguration

Returns the “default value” for a type.

impl PartialEq<ElasticsearchDestinationConfiguration> for ElasticsearchDestinationConfiguration

fn eq(&self, other: &ElasticsearchDestinationConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ElasticsearchDestinationConfiguration) -> bool

This method tests for !=.

impl Serialize for ElasticsearchDestinationConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ElasticsearchDestinationConfiguration