AWS::KinesisFirehose::DeliveryStream ElasticsearchDestinationConfiguration
The ElasticsearchDestinationConfiguration property type specifies an Amazon
Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data
Firehose) delivers data to.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "BufferingHints" :ElasticsearchBufferingHints, "CloudWatchLoggingOptions" :CloudWatchLoggingOptions, "ClusterEndpoint" :String, "DocumentIdOptions" :DocumentIdOptions, "DomainARN" :String, "IndexName" :String, "IndexRotationPeriod" :String, "ProcessingConfiguration" :ProcessingConfiguration, "RetryOptions" :ElasticsearchRetryOptions, "RoleARN" :String, "S3BackupMode" :String, "S3Configuration" :S3DestinationConfiguration, "TypeName" :String, "VpcConfiguration" :VpcConfiguration}
YAML
BufferingHints:ElasticsearchBufferingHintsCloudWatchLoggingOptions:CloudWatchLoggingOptionsClusterEndpoint:StringDocumentIdOptions:DocumentIdOptionsDomainARN:StringIndexName:StringIndexRotationPeriod:StringProcessingConfiguration:ProcessingConfigurationRetryOptions:ElasticsearchRetryOptionsRoleARN:StringS3BackupMode:StringS3Configuration:S3DestinationConfigurationTypeName:StringVpcConfiguration:VpcConfiguration
Properties
BufferingHints-
Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.
Required: No
Type: ElasticsearchBufferingHints
Update requires: No interruption
CloudWatchLoggingOptions-
The Amazon CloudWatch Logs logging options for the delivery stream.
Required: No
Type: CloudWatchLoggingOptions
Update requires: No interruption
ClusterEndpoint-
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpointor theDomainARNfield.Required: No
Type: String
Pattern:
https:.*Minimum:
1Maximum:
512Update requires: No interruption
DocumentIdOptions-
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Required: No
Type: DocumentIdOptions
Update requires: No interruption
DomainARN-
The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeElasticsearchDomain,DescribeElasticsearchDomains, andDescribeElasticsearchDomainConfigafter assuming the role specified in RoleARN.Specify either
ClusterEndpointorDomainARN.Required: No
Type: String
Pattern:
arn:.*Minimum:
1Maximum:
512Update requires: No interruption
IndexName-
The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.
Required: Yes
Type: String
Minimum:
1Maximum:
80Update requires: No interruption
IndexRotationPeriod-
The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide.
Required: No
Type: String
Allowed values:
NoRotation | OneHour | OneDay | OneWeek | OneMonthUpdate requires: No interruption
ProcessingConfiguration-
The data processing configuration for the Kinesis Data Firehose delivery stream.
Required: No
Type: ProcessingConfiguration
Update requires: No interruption
RetryOptions-
The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.
Required: No
Type: ElasticsearchRetryOptions
Update requires: No interruption
RoleARN-
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 Controlling Access with Amazon Kinesis Data Firehose.
Required: Yes
Type: String
Pattern:
arn:.*Minimum:
1Maximum:
512Update requires: No interruption
S3BackupMode-
The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the
S3BackupModecontent for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference.Required: No
Type: String
Allowed values:
FailedDocumentsOnly | AllDocumentsUpdate requires: No interruption
S3Configuration-
The S3 bucket where Kinesis Data Firehose backs up incoming data.
Required: Yes
Type: S3DestinationConfiguration
Update requires: No interruption
TypeName-
The Elasticsearch type name that Amazon ES adds to documents when indexing data.
Required: No
Type: String
Minimum:
0Maximum:
100Update requires: No interruption
VpcConfiguration-
The details of the VPC of the Amazon ES destination.
Required: No
Type: VpcConfiguration
Update requires: Replacement
