ElasticsearchDestinationUpdate
Describes an update for a destination in Amazon OpenSearch Service.
Types
Properties
The buffering options. If no value is specified, ElasticsearchBufferingHints
object default values are used.
The CloudWatch logging options for your Firehose stream.
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint
or the DomainARN
field.
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain
, DescribeDomains
, and DescribeDomainConfig
after assuming the IAM role specified in RoleARN
. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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 OpenSearch Service Destination. Default value is OneDay
.
The data processing configuration.
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
The Amazon S3 destination.