com.pulumi.awsnative.rds.kotlin.inputs.DbClusterReadEndpointArgs.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.rds.kotlin.inputs

import com.pulumi.awsnative.rds.inputs.DbClusterReadEndpointArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * The ``ReadEndpoint`` return value specifies the reader endpoint for the DB cluster.
 *  The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
 *  If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
 *  For more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) in the *Amazon Aurora User Guide*.
 * @property address The host address of the reader endpoint.
 */
public data class DbClusterReadEndpointArgs(
    public val address: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.rds.inputs.DbClusterReadEndpointArgs =
        com.pulumi.awsnative.rds.inputs.DbClusterReadEndpointArgs.builder()
            .address(address?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [DbClusterReadEndpointArgs].
 */
@PulumiTagMarker
public class DbClusterReadEndpointArgsBuilder internal constructor() {
    private var address: Output? = null

    /**
     * @param value The host address of the reader endpoint.
     */
    @JvmName("difwexsbdxjqnkts")
    public suspend fun address(`value`: Output) {
        this.address = value
    }

    /**
     * @param value The host address of the reader endpoint.
     */
    @JvmName("bemryyctvixlgjoc")
    public suspend fun address(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.address = mapped
    }

    internal fun build(): DbClusterReadEndpointArgs = DbClusterReadEndpointArgs(
        address = address,
    )
}