AmazonOpenSearchServerlessDestinationConfiguration - Amazon Data Firehose
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AmazonOpenSearchServerlessDestinationConfiguration

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

Contents

IndexName

The Serverless offering for Amazon OpenSearch Service index name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: .*

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: Yes

S3Configuration

Describes the configuration of a destination in Amazon S3.

Type: S3DestinationConfiguration object

Required: Yes

BufferingHints

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

Type: AmazonOpenSearchServerlessBufferingHints object

Required: No

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

Type: CloudWatchLoggingOptions object

Required: No

CollectionEndpoint

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: https:.*

Required: No

ProcessingConfiguration

Describes a data processing configuration.

Type: ProcessingConfiguration object

Required: No

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).

Type: AmazonOpenSearchServerlessRetryOptions object

Required: No

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.

Type: String

Valid Values: FailedDocumentsOnly | AllDocuments

Required: No

VpcConfiguration

The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.

Type: VpcConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: