Struct aws_sdk_firehose::model::ElasticsearchDestinationUpdate

#[non_exhaustive]
pub struct ElasticsearchDestinationUpdate {
    pub role_arn: Option<String>,
    pub domain_arn: Option<String>,
    pub cluster_endpoint: Option<String>,
    pub index_name: Option<String>,
    pub type_name: Option<String>,
    pub index_rotation_period: Option<ElasticsearchIndexRotationPeriod>,
    pub buffering_hints: Option<ElasticsearchBufferingHints>,
    pub retry_options: Option<ElasticsearchRetryOptions>,
    pub s3_update: Option<S3DestinationUpdate>,
    pub processing_configuration: Option<ProcessingConfiguration>,
    pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
}

Describes an update for a destination in Amazon ES.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

role_arn: Option<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.

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

Specify either ClusterEndpoint or DomainARN.

cluster_endpoint: Option<String>

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

index_name: Option<String>

The Elasticsearch index name.

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

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

index_rotation_period: Option<ElasticsearchIndexRotationPeriod>

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.

buffering_hints: Option<ElasticsearchBufferingHints>

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

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

s3_update: Option<S3DestinationUpdate>

The Amazon S3 destination.

processing_configuration: Option<ProcessingConfiguration>

The data processing configuration.

cloud_watch_logging_options: Option<CloudWatchLoggingOptions>

The CloudWatch logging options for your delivery stream.

Implementations

impl ElasticsearchDestinationUpdate

pub fn role_arn(&self) -> Option<&str>

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.

pub fn domain_arn(&self) -> Option<&str>

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.

Specify either ClusterEndpoint or DomainARN.

pub fn cluster_endpoint(&self) -> Option<&str>

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

pub fn index_name(&self) -> Option<&str>

The Elasticsearch index name.

pub fn type_name(&self) -> Option<&str>

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.

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

pub fn index_rotation_period(&self) -> Option<&ElasticsearchIndexRotationPeriod>

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.

pub fn buffering_hints(&self) -> Option<&ElasticsearchBufferingHints>

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

pub fn retry_options(&self) -> 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).

pub fn s3_update(&self) -> Option<&S3DestinationUpdate>

The Amazon S3 destination.

pub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>

The data processing configuration.

pub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>

The CloudWatch logging options for your delivery stream.

impl ElasticsearchDestinationUpdate

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ElasticsearchDestinationUpdate

Trait Implementations

impl Clone for ElasticsearchDestinationUpdate

fn clone(&self) -> ElasticsearchDestinationUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ElasticsearchDestinationUpdate

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

Formats the value using the given formatter.

impl PartialEq<ElasticsearchDestinationUpdate> for ElasticsearchDestinationUpdate

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

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

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

This method tests for !=.

impl StructuralPartialEq for ElasticsearchDestinationUpdate