commonMain.aws.sdk.kotlin.services.firehose.model.ElasticsearchDestinationUpdate.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of firehose-jvm Show documentation
Show all versions of firehose-jvm Show documentation
The AWS SDK for Kotlin client for Firehose
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.firehose.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* Describes an update for a destination in Amazon ES.
*/
public class ElasticsearchDestinationUpdate private constructor(builder: Builder) {
/**
* The buffering options. If no value is specified, `ElasticsearchBufferingHints` object default values are used.
*/
public val bufferingHints: aws.sdk.kotlin.services.firehose.model.ElasticsearchBufferingHints? = builder.bufferingHints
/**
* The CloudWatch logging options for your Firehose stream.
*/
public val cloudWatchLoggingOptions: aws.sdk.kotlin.services.firehose.model.CloudWatchLoggingOptions? = builder.cloudWatchLoggingOptions
/**
* The endpoint to use when communicating with the cluster. Specify either this `ClusterEndpoint` or the `DomainARN` field.
*/
public val clusterEndpoint: kotlin.String? = builder.clusterEndpoint
/**
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
*/
public val documentIdOptions: aws.sdk.kotlin.services.firehose.model.DocumentIdOptions? = builder.documentIdOptions
/**
* The ARN of the Amazon ES domain. The IAM role must have permissions for `DescribeDomain`, `DescribeDomains`, and `DescribeDomainConfig` after assuming the IAM role specified in `RoleARN`. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
*
* Specify either `ClusterEndpoint` or `DomainARN`.
*/
public val domainArn: kotlin.String? = builder.domainArn
/**
* The Elasticsearch index name.
*/
public val indexName: kotlin.String? = builder.indexName
/**
* The Elasticsearch index rotation period. Index rotation appends a timestamp to `IndexName` to facilitate the expiration of old data. For more information, see [Index Rotation for the Amazon ES Destination](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). Default value is `OneDay`.
*/
public val indexRotationPeriod: aws.sdk.kotlin.services.firehose.model.ElasticsearchIndexRotationPeriod? = builder.indexRotationPeriod
/**
* The data processing configuration.
*/
public val processingConfiguration: aws.sdk.kotlin.services.firehose.model.ProcessingConfiguration? = builder.processingConfiguration
/**
* The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
*/
public val retryOptions: aws.sdk.kotlin.services.firehose.model.ElasticsearchRetryOptions? = builder.retryOptions
/**
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see [Grant Firehose Access to an Amazon S3 Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) and [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
*/
public val roleArn: kotlin.String? = builder.roleArn
/**
* The Amazon S3 destination.
*/
public val s3Update: aws.sdk.kotlin.services.firehose.model.S3DestinationUpdate? = builder.s3Update
/**
* The Elasticsearch 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.
*
* If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for `TypeName`.
*/
public val typeName: kotlin.String? = builder.typeName
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.firehose.model.ElasticsearchDestinationUpdate = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("ElasticsearchDestinationUpdate(")
append("bufferingHints=$bufferingHints,")
append("cloudWatchLoggingOptions=$cloudWatchLoggingOptions,")
append("clusterEndpoint=$clusterEndpoint,")
append("documentIdOptions=$documentIdOptions,")
append("domainArn=$domainArn,")
append("indexName=$indexName,")
append("indexRotationPeriod=$indexRotationPeriod,")
append("processingConfiguration=$processingConfiguration,")
append("retryOptions=$retryOptions,")
append("roleArn=$roleArn,")
append("s3Update=$s3Update,")
append("typeName=$typeName")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = bufferingHints?.hashCode() ?: 0
result = 31 * result + (cloudWatchLoggingOptions?.hashCode() ?: 0)
result = 31 * result + (clusterEndpoint?.hashCode() ?: 0)
result = 31 * result + (documentIdOptions?.hashCode() ?: 0)
result = 31 * result + (domainArn?.hashCode() ?: 0)
result = 31 * result + (indexName?.hashCode() ?: 0)
result = 31 * result + (indexRotationPeriod?.hashCode() ?: 0)
result = 31 * result + (processingConfiguration?.hashCode() ?: 0)
result = 31 * result + (retryOptions?.hashCode() ?: 0)
result = 31 * result + (roleArn?.hashCode() ?: 0)
result = 31 * result + (s3Update?.hashCode() ?: 0)
result = 31 * result + (typeName?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as ElasticsearchDestinationUpdate
if (bufferingHints != other.bufferingHints) return false
if (cloudWatchLoggingOptions != other.cloudWatchLoggingOptions) return false
if (clusterEndpoint != other.clusterEndpoint) return false
if (documentIdOptions != other.documentIdOptions) return false
if (domainArn != other.domainArn) return false
if (indexName != other.indexName) return false
if (indexRotationPeriod != other.indexRotationPeriod) return false
if (processingConfiguration != other.processingConfiguration) return false
if (retryOptions != other.retryOptions) return false
if (roleArn != other.roleArn) return false
if (s3Update != other.s3Update) return false
if (typeName != other.typeName) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.firehose.model.ElasticsearchDestinationUpdate = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The buffering options. If no value is specified, `ElasticsearchBufferingHints` object default values are used.
*/
public var bufferingHints: aws.sdk.kotlin.services.firehose.model.ElasticsearchBufferingHints? = null
/**
* The CloudWatch logging options for your Firehose stream.
*/
public var cloudWatchLoggingOptions: aws.sdk.kotlin.services.firehose.model.CloudWatchLoggingOptions? = null
/**
* The endpoint to use when communicating with the cluster. Specify either this `ClusterEndpoint` or the `DomainARN` field.
*/
public var clusterEndpoint: kotlin.String? = null
/**
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
*/
public var documentIdOptions: aws.sdk.kotlin.services.firehose.model.DocumentIdOptions? = null
/**
* The ARN of the Amazon ES domain. The IAM role must have permissions for `DescribeDomain`, `DescribeDomains`, and `DescribeDomainConfig` after assuming the IAM role specified in `RoleARN`. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
*
* Specify either `ClusterEndpoint` or `DomainARN`.
*/
public var domainArn: kotlin.String? = null
/**
* The Elasticsearch index name.
*/
public var indexName: kotlin.String? = null
/**
* The Elasticsearch index rotation period. Index rotation appends a timestamp to `IndexName` to facilitate the expiration of old data. For more information, see [Index Rotation for the Amazon ES Destination](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). Default value is `OneDay`.
*/
public var indexRotationPeriod: aws.sdk.kotlin.services.firehose.model.ElasticsearchIndexRotationPeriod? = null
/**
* The data processing configuration.
*/
public var processingConfiguration: aws.sdk.kotlin.services.firehose.model.ProcessingConfiguration? = null
/**
* The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
*/
public var retryOptions: aws.sdk.kotlin.services.firehose.model.ElasticsearchRetryOptions? = null
/**
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see [Grant Firehose Access to an Amazon S3 Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) and [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
*/
public var roleArn: kotlin.String? = null
/**
* The Amazon S3 destination.
*/
public var s3Update: aws.sdk.kotlin.services.firehose.model.S3DestinationUpdate? = null
/**
* The Elasticsearch 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.
*
* If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for `TypeName`.
*/
public var typeName: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.firehose.model.ElasticsearchDestinationUpdate) : this() {
this.bufferingHints = x.bufferingHints
this.cloudWatchLoggingOptions = x.cloudWatchLoggingOptions
this.clusterEndpoint = x.clusterEndpoint
this.documentIdOptions = x.documentIdOptions
this.domainArn = x.domainArn
this.indexName = x.indexName
this.indexRotationPeriod = x.indexRotationPeriod
this.processingConfiguration = x.processingConfiguration
this.retryOptions = x.retryOptions
this.roleArn = x.roleArn
this.s3Update = x.s3Update
this.typeName = x.typeName
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.firehose.model.ElasticsearchDestinationUpdate = ElasticsearchDestinationUpdate(this)
/**
* construct an [aws.sdk.kotlin.services.firehose.model.ElasticsearchBufferingHints] inside the given [block]
*/
public fun bufferingHints(block: aws.sdk.kotlin.services.firehose.model.ElasticsearchBufferingHints.Builder.() -> kotlin.Unit) {
this.bufferingHints = aws.sdk.kotlin.services.firehose.model.ElasticsearchBufferingHints.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.firehose.model.CloudWatchLoggingOptions] inside the given [block]
*/
public fun cloudWatchLoggingOptions(block: aws.sdk.kotlin.services.firehose.model.CloudWatchLoggingOptions.Builder.() -> kotlin.Unit) {
this.cloudWatchLoggingOptions = aws.sdk.kotlin.services.firehose.model.CloudWatchLoggingOptions.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.firehose.model.DocumentIdOptions] inside the given [block]
*/
public fun documentIdOptions(block: aws.sdk.kotlin.services.firehose.model.DocumentIdOptions.Builder.() -> kotlin.Unit) {
this.documentIdOptions = aws.sdk.kotlin.services.firehose.model.DocumentIdOptions.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.firehose.model.ProcessingConfiguration] inside the given [block]
*/
public fun processingConfiguration(block: aws.sdk.kotlin.services.firehose.model.ProcessingConfiguration.Builder.() -> kotlin.Unit) {
this.processingConfiguration = aws.sdk.kotlin.services.firehose.model.ProcessingConfiguration.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.firehose.model.ElasticsearchRetryOptions] inside the given [block]
*/
public fun retryOptions(block: aws.sdk.kotlin.services.firehose.model.ElasticsearchRetryOptions.Builder.() -> kotlin.Unit) {
this.retryOptions = aws.sdk.kotlin.services.firehose.model.ElasticsearchRetryOptions.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.firehose.model.S3DestinationUpdate] inside the given [block]
*/
public fun s3Update(block: aws.sdk.kotlin.services.firehose.model.S3DestinationUpdate.Builder.() -> kotlin.Unit) {
this.s3Update = aws.sdk.kotlin.services.firehose.model.S3DestinationUpdate.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}