#[non_exhaustive]pub struct ElasticsearchDestinationConfiguration {Show 13 fields
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_backup_mode: Option<ElasticsearchS3BackupMode>,
pub s3_configuration: Option<S3DestinationConfiguration>,
pub processing_configuration: Option<ProcessingConfiguration>,
pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
pub vpc_configuration: Option<VpcConfiguration>,
}
Expand description
Describes the configuration of 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 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 run time.
For Elasticsearch 7.x, don't specify a TypeName
.
index_rotation_period: Option<ElasticsearchIndexRotationPeriod>
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
.
buffering_hints: Option<ElasticsearchBufferingHints>
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints
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_backup_mode: Option<ElasticsearchS3BackupMode>
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: Option<S3DestinationConfiguration>
The configuration for the backup Amazon S3 location.
processing_configuration: Option<ProcessingConfiguration>
The data processing configuration.
cloud_watch_logging_options: Option<CloudWatchLoggingOptions>
The Amazon CloudWatch logging options for your delivery stream.
vpc_configuration: Option<VpcConfiguration>
The details of the VPC of the Amazon ES destination.
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 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 run time.
For Elasticsearch 7.x, don't specify a TypeName
.
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
.
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints
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).
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.
The configuration for the backup Amazon S3 location.
The data processing configuration.
The Amazon CloudWatch logging options for your delivery stream.
The details of the VPC of the Amazon ES destination.
Creates a new builder-style object to manufacture ElasticsearchDestinationConfiguration
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
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