AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessDestinationConfiguration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "BufferingHints" : AmazonOpenSearchServerlessBufferingHints,
  "CloudWatchLoggingOptions" : CloudWatchLoggingOptions,
  "CollectionEndpoint" : String,
  "IndexName" : String,
  "ProcessingConfiguration" : ProcessingConfiguration,
  "RetryOptions" : AmazonOpenSearchServerlessRetryOptions,
  "RoleARN" : String,
  "S3BackupMode" : String,
  "S3Configuration" : S3DestinationConfiguration,
  "VpcConfiguration" : VpcConfiguration
}

YAML


  BufferingHints: 
    AmazonOpenSearchServerlessBufferingHints
  CloudWatchLoggingOptions: 
    CloudWatchLoggingOptions
  CollectionEndpoint: String
  IndexName: String
  ProcessingConfiguration: 
    ProcessingConfiguration
  RetryOptions: 
    AmazonOpenSearchServerlessRetryOptions
  RoleARN: String
  S3BackupMode: String
  S3Configuration: 
    S3DestinationConfiguration
  VpcConfiguration: 
    VpcConfiguration

Properties

BufferingHints

The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

Required: No

Type: AmazonOpenSearchServerlessBufferingHints

Update requires: No interruption

CloudWatchLoggingOptions

Property description not available.

Required: No

Type: CloudWatchLoggingOptions

Update requires: No interruption

CollectionEndpoint

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

Required: No

Type: String

Pattern: https:.*

Minimum: 1

Maximum: 512

Update requires: No interruption

IndexName

The Serverless offering for Amazon OpenSearch Service index name.

Required: Yes

Type: String

Minimum: 1

Maximum: 80

Update requires: No interruption

ProcessingConfiguration

Property description not available.

Required: No

Type: ProcessingConfiguration

Update requires: No interruption

RetryOptions

The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

Required: No

Type: AmazonOpenSearchServerlessRetryOptions

Update requires: No interruption

RoleARN

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

Required: Yes

Type: String

Pattern: arn:.*

Minimum: 1

Maximum: 512

Update requires: No interruption

S3BackupMode

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

Required: No

Type: String

Allowed values: FailedDocumentsOnly | AllDocuments

Update requires: No interruption

S3Configuration