firehose/aws.sdk.kotlin.services.firehose.model/AmazonOpenSearchServerlessDestinationConfiguration/Builder

Builder

Properties

var bufferingHints: AmazonOpenSearchServerlessBufferingHints?

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

cloudWatchLoggingOptions

var cloudWatchLoggingOptions: CloudWatchLoggingOptions?

Describes the Amazon CloudWatch logging options for your Firehose stream.

collectionEndpoint

var collectionEndpoint: String?

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

var indexName: String?

The Serverless offering for Amazon OpenSearch Service index name.

processingConfiguration

var processingConfiguration: ProcessingConfiguration?

Describes a data processing configuration.

var retryOptions: AmazonOpenSearchServerlessRetryOptions?

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

var roleArn: String?

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.

var s3BackupMode: AmazonOpenSearchServerlessS3BackupMode?

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.

s3Configuration

var s3Configuration: S3DestinationConfiguration?

Describes the configuration of a destination in Amazon S3.

vpcConfiguration

var vpcConfiguration: VpcConfiguration?

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

Functions

fun bufferingHints(block: AmazonOpenSearchServerlessBufferingHints.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.firehose.model.AmazonOpenSearchServerlessBufferingHints inside the given block

cloudWatchLoggingOptions

fun cloudWatchLoggingOptions(block: CloudWatchLoggingOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.firehose.model.CloudWatchLoggingOptions inside the given block

processingConfiguration

fun processingConfiguration(block: ProcessingConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.firehose.model.ProcessingConfiguration inside the given block

fun retryOptions(block: AmazonOpenSearchServerlessRetryOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.firehose.model.AmazonOpenSearchServerlessRetryOptions inside the given block

s3Configuration

fun s3Configuration(block: S3DestinationConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.firehose.model.S3DestinationConfiguration inside the given block

vpcConfiguration

fun vpcConfiguration(block: VpcConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.firehose.model.VpcConfiguration inside the given block