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

Builder

class Builder

Properties

bufferingHints

var bufferingHints: AmazonopensearchserviceBufferingHints?

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.

clusterEndpoint

var clusterEndpoint: String?

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

documentIdOptions

var documentIdOptions: DocumentIdOptions?

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

domainArn

var domainArn: String?

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

indexName

var indexName: String?

The ElasticsearAmazon OpenSearch Service index name.

indexRotationPeriod

var indexRotationPeriod: AmazonopensearchserviceIndexRotationPeriod?

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

processingConfiguration

var processingConfiguration: ProcessingConfiguration?

Describes a data processing configuration.

retryOptions

var retryOptions: AmazonopensearchserviceRetryOptions?

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

roleArn

var roleArn: String?

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

s3BackupMode

var s3BackupMode: AmazonopensearchserviceS3BackupMode?

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.

typeName

var typeName: String?

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.

vpcConfiguration

var vpcConfiguration: VpcConfiguration?

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