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

Builder

class Builder

Properties

bufferingHints

var bufferingHints: AmazonopensearchserviceBufferingHints?

The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

cloudWatchLoggingOptions

var cloudWatchLoggingOptions: CloudWatchLoggingOptions?

Describes the Amazon CloudWatch logging options for your delivery 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 DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

indexName

var indexName: String?

The Amazon OpenSearch Service index name.

indexRotationPeriod

var indexRotationPeriod: AmazonopensearchserviceIndexRotationPeriod?

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to 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.

s3Update

var s3Update: S3DestinationUpdate?

Describes an update for 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 runtime.