com.pulumi.aws.alb.kotlin.outputs.TargetGroupHealthCheck.kt Maven / Gradle / Ivy

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

package com.pulumi.aws.alb.kotlin.outputs

import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress

/**
 *
 * @property enabled Whether health checks are enabled. Defaults to `true`.
 * @property healthyThreshold Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
 * @property interval Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For `lambda` target groups, it needs to be greater than the timeout of the underlying `lambda`. Defaults to 30.
 * @property matcher The HTTP or gRPC codes to use when checking for a successful response from a target.
 * The `health_check.protocol` must be one of `HTTP` or `HTTPS` or the `target_type` must be `lambda`.
 * Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").
 * * For gRPC-based target groups (i.e., the `protocol` is one of `HTTP` or `HTTPS` and the `protocol_version` is `GRPC`), values can be between `0` and `99`. The default is `12`.
 * * When used with an Application Load Balancer (i.e., the `protocol` is one of `HTTP` or `HTTPS` and the `protocol_version` is not `GRPC`), values can be between `200` and `499`. The default is `200`.
 * * When used with a Network Load Balancer (i.e., the `protocol` is one of `TCP`, `TCP_UDP`, `UDP`, or `TLS`), values can be between `200` and `599`. The default is `200-399`.
 * * When the `target_type` is `lambda`, values can be between `200` and `499`. The default is `200`.
 * @property path Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
 * * For HTTP and HTTPS health checks, the default is `/`.
 * * For gRPC health checks, the default is `/AWS.ALB/healthcheck`.
 * @property port The port the load balancer uses when performing health checks on targets.
 * Valid values are either `traffic-port`, to use the same port as the target group, or a valid port number between `1` and `65536`.
 * Default is `traffic-port`.
 * @property protocol Protocol the load balancer uses when performing health checks on targets.
 * Must be one of `TCP`, `HTTP`, or `HTTPS`.
 * The `TCP` protocol is not supported for health checks if the protocol of the target group is `HTTP` or `HTTPS`.
 * Default is `HTTP`.
 * Cannot be specified when the `target_type` is `lambda`.
 * @property timeout Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
 * @property unhealthyThreshold Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
 */
public data class TargetGroupHealthCheck(
    public val enabled: Boolean? = null,
    public val healthyThreshold: Int? = null,
    public val interval: Int? = null,
    public val matcher: String? = null,
    public val path: String? = null,
    public val port: String? = null,
    public val protocol: String? = null,
    public val timeout: Int? = null,
    public val unhealthyThreshold: Int? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.aws.alb.outputs.TargetGroupHealthCheck): TargetGroupHealthCheck = TargetGroupHealthCheck(
            enabled = javaType.enabled().map({ args0 -> args0 }).orElse(null),
            healthyThreshold = javaType.healthyThreshold().map({ args0 -> args0 }).orElse(null),
            interval = javaType.interval().map({ args0 -> args0 }).orElse(null),
            matcher = javaType.matcher().map({ args0 -> args0 }).orElse(null),
            path = javaType.path().map({ args0 -> args0 }).orElse(null),
            port = javaType.port().map({ args0 -> args0 }).orElse(null),
            protocol = javaType.protocol().map({ args0 -> args0 }).orElse(null),
            timeout = javaType.timeout().map({ args0 -> args0 }).orElse(null),
            unhealthyThreshold = javaType.unhealthyThreshold().map({ args0 -> args0 }).orElse(null),
        )
    }
}