com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionContainerDependencyArgs.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.ecs.kotlin.inputs

import com.pulumi.awsnative.ecs.inputs.TaskDefinitionContainerDependencyArgs.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 ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
 *  Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
 *   For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
 * @property condition The dependency condition of the container. The following are the available conditions and their behavior:
 *   +   ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
 *   +   ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
 *   +   ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.
 *   +   ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
 * @property containerName The name of a container.
 */
public data class TaskDefinitionContainerDependencyArgs(
    public val condition: Output? = null,
    public val containerName: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.ecs.inputs.TaskDefinitionContainerDependencyArgs =
        com.pulumi.awsnative.ecs.inputs.TaskDefinitionContainerDependencyArgs.builder()
            .condition(condition?.applyValue({ args0 -> args0 }))
            .containerName(containerName?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [TaskDefinitionContainerDependencyArgs].
 */
@PulumiTagMarker
public class TaskDefinitionContainerDependencyArgsBuilder internal constructor() {
    private var condition: Output? = null

    private var containerName: Output? = null

    /**
     * @param value The dependency condition of the container. The following are the available conditions and their behavior:
     *   +   ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
     *   +   ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
     *   +   ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.
     *   +   ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
     */
    @JvmName("inoenbdovniamwju")
    public suspend fun condition(`value`: Output) {
        this.condition = value
    }

    /**
     * @param value The name of a container.
     */
    @JvmName("cnveitnbvoqniltb")
    public suspend fun containerName(`value`: Output) {
        this.containerName = value
    }

    /**
     * @param value The dependency condition of the container. The following are the available conditions and their behavior:
     *   +   ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
     *   +   ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
     *   +   ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.
     *   +   ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
     */
    @JvmName("yngtxrgtimtyxgay")
    public suspend fun condition(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.condition = mapped
    }

    /**
     * @param value The name of a container.
     */
    @JvmName("gkfpfqopwvycxpyx")
    public suspend fun containerName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.containerName = mapped
    }

    internal fun build(): TaskDefinitionContainerDependencyArgs =
        TaskDefinitionContainerDependencyArgs(
            condition = condition,
            containerName = containerName,
        )
}