Struct aws_sdk_firehose::model::ElasticsearchDestinationUpdate
source ·
[−]#[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>,
}
Expand description
Describes an update for a destination in Amazon ES.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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
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.
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
.
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint
or the DomainARN
field.
The Elasticsearch index name.
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
.
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
.
The buffering options. If no value is specified, ElasticsearchBufferingHints
object default values are used.
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
The Amazon S3 destination.
The data processing configuration.
The CloudWatch logging options for your delivery stream.
Creates a new builder-style object to manufacture ElasticsearchDestinationUpdate
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl Send for ElasticsearchDestinationUpdate
impl Sync for ElasticsearchDestinationUpdate
impl Unpin for ElasticsearchDestinationUpdate
impl UnwindSafe for ElasticsearchDestinationUpdate
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more