This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::KinesisFirehose::DeliveryStream AmazonopensearchserviceDestinationConfiguration
Describes the configuration of a destination in Amazon OpenSearch Service.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "BufferingHints" :AmazonopensearchserviceBufferingHints, "CloudWatchLoggingOptions" :CloudWatchLoggingOptions, "ClusterEndpoint" :String, "DocumentIdOptions" :DocumentIdOptions, "DomainARN" :String, "IndexName" :String, "IndexRotationPeriod" :String, "ProcessingConfiguration" :ProcessingConfiguration, "RetryOptions" :AmazonopensearchserviceRetryOptions, "RoleARN" :String, "S3BackupMode" :String, "S3Configuration" :S3DestinationConfiguration, "TypeName" :String, "VpcConfiguration" :VpcConfiguration}
YAML
BufferingHints:AmazonopensearchserviceBufferingHintsCloudWatchLoggingOptions:CloudWatchLoggingOptionsClusterEndpoint:StringDocumentIdOptions:DocumentIdOptionsDomainARN:StringIndexName:StringIndexRotationPeriod:StringProcessingConfiguration:ProcessingConfigurationRetryOptions:AmazonopensearchserviceRetryOptionsRoleARN:StringS3BackupMode:StringS3Configuration:S3DestinationConfigurationTypeName:StringVpcConfiguration:VpcConfiguration
Properties
BufferingHints-
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Required: No
Type: AmazonopensearchserviceBufferingHints
Update requires: No interruption
CloudWatchLoggingOptions-
Describes the Amazon CloudWatch logging options for your delivery stream.
Required: No
Type: CloudWatchLoggingOptions
Update requires: No interruption
ClusterEndpoint-
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
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 OpenSearch Service domain.
Required: No
Type: String
Pattern:
arn:.*Minimum:
1Maximum:
512Update requires: No interruption
IndexName-
The Amazon OpenSearch Service index name.
Required: Yes
Type: String
Minimum:
1Maximum:
80Update requires: No interruption
IndexRotationPeriod-
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
Required: No
Type: String
Allowed values:
NoRotation | OneHour | OneDay | OneWeek | OneMonthUpdate requires: No interruption
ProcessingConfiguration-
Describes a data processing configuration.
Required: No
Type: ProcessingConfiguration
Update requires: No interruption
RetryOptions-
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
Required: No
Type: AmazonopensearchserviceRetryOptions
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 OpenSearch Service Configuration API and for indexing documents.
Required: Yes
Type: String
Pattern:
arn:.*Minimum:
1Maximum:
512Update requires: No interruption
S3BackupMode-
Defines how documents should be delivered to Amazon S3.
Required: No
Type: String
Allowed values:
FailedDocumentsOnly | AllDocumentsUpdate requires: No interruption
S3Configuration-
Describes the configuration of a destination in Amazon S3.
Required: Yes
Type: S3DestinationConfiguration
Update requires: No interruption
TypeName-
The Amazon OpenSearch Service type name.
Required: No
Type: String
Minimum:
0Maximum:
100Update requires: No interruption
VpcConfiguration-
The details of the VPC of the Amazon OpenSearch Service destination.
Required: No
Type: VpcConfiguration
Update requires: Replacement
