• Home
• org.virtuslab
• pulumi-aws-native-kotlin
• 0.112.0.0
• source code
• JobDefinitionTaskContainerProperties.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionTaskContainerProperties.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.batch.kotlin.outputs

import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 *
 * @property command The command that's passed to the container. This parameter maps to `Cmd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `COMMAND` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . For more information, see [Dockerfile reference: CMD](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) .
 * @property dependsOn A list of containers that this container depends on.
 * @property environment The environment variables to pass to a container. This parameter maps to Env inthe [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--env` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
 * > We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables cannot start with `AWS_BATCH` . This naming convention is reserved for variables that AWS Batch sets.
 * @property essential If the essential parameter of a container is marked as `true` , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the `essential` parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
 * All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide* .
 * @property image The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either `repository-url/image:tag` or `repository-url/image@digest` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to `Image` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of the [*docker run*](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .
 * @property linuxParameters Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) .
 * @property logConfiguration The log configuration specification for the container.
 * This parameter maps to `LogConfig` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .
 * By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the *Docker documentation* .
 * > Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the `LogConfiguration` data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
 * This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version `--format '{{.Server.APIVersion}}'`
 * > The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* .
 * @property mountPoints The mount points for data volumes in your container.
 * This parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the [--volume](https://docs.aws.amazon.com/) option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .
 * Windows containers can mount whole directories on the same drive as `$env:ProgramData` . Windows containers can't mount directories on a different drive, and mount point can't be across drives.
 * @property name The name of a container. The name can be used as a unique identifier to target your `dependsOn` and `Overrides` objects.
 * @property privileged When this parameter is `true` , the container is given elevated privileges on the host container instance (similar to the `root` user). This parameter maps to `Privileged` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .
 * > This parameter is not supported for Windows containers or tasks run on Fargate.
 * @property readonlyRootFilesystem When this parameter is true, the container is given read-only access to its root file system. This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--read-only` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .
 * > This parameter is not supported for Windows containers.
 * @property repositoryCredentials The private repository authentication credentials to use.
 * @property resourceRequirements The type and amount of a resource to assign to a container. The only supported resource is a GPU.
 * @property secrets The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the Amazon Elastic Container Service Developer Guide.
 * @property ulimits A list of `ulimits` to set in the container. If a `ulimit` value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to `Ulimits` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .
 * Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The `nofile` resource limit sets a restriction on the number of open files that a container can use. The default `nofile` soft limit is `1024` and the default hard limit is `65535` .
 * This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version `--format '{{.Server.APIVersion}}'`
 * > This parameter is not supported for Windows containers.
 * @property user The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
 * > When running tasks using the `host` network mode, don't run containers using the `root user (UID 0)` . We recommend using a non-root user for better security.
 * You can specify the `user` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.
 * - `user`
 * - `user:group`
 * - `uid`
 * - `uid:gid`
 * - `user:gi`
 * - `uid:group`
 * > This parameter is not supported for Windows containers.
 */
public data class JobDefinitionTaskContainerProperties(
    public val command: List? = null,
    public val dependsOn: List? = null,
    public val environment: List? = null,
    public val essential: Boolean? = null,
    public val image: String,
    public val linuxParameters: JobDefinitionLinuxParameters? = null,
    public val logConfiguration: JobDefinitionLogConfiguration? = null,
    public val mountPoints: List? = null,
    public val name: String? = null,
    public val privileged: Boolean? = null,
    public val readonlyRootFilesystem: Boolean? = null,
    public val repositoryCredentials: JobDefinitionRepositoryCredentials? = null,
    public val resourceRequirements: List? = null,
    public val secrets: List? = null,
    public val ulimits: List? = null,
    public val user: String? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.batch.outputs.JobDefinitionTaskContainerProperties): JobDefinitionTaskContainerProperties = JobDefinitionTaskContainerProperties(
            command = javaType.command().map({ args0 -> args0 }),
            dependsOn = javaType.dependsOn().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionTaskContainerDependency.Companion.toKotlin(args0)
                })
            }),
            environment = javaType.environment().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionEnvironment.Companion.toKotlin(args0)
                })
            }),
            essential = javaType.essential().map({ args0 -> args0 }).orElse(null),
            image = javaType.image(),
            linuxParameters = javaType.linuxParameters().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionLinuxParameters.Companion.toKotlin(args0)
                })
            }).orElse(null),
            logConfiguration = javaType.logConfiguration().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionLogConfiguration.Companion.toKotlin(args0)
                })
            }).orElse(null),
            mountPoints = javaType.mountPoints().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionMountPoints.Companion.toKotlin(args0)
                })
            }),
            name = javaType.name().map({ args0 -> args0 }).orElse(null),
            privileged = javaType.privileged().map({ args0 -> args0 }).orElse(null),
            readonlyRootFilesystem = javaType.readonlyRootFilesystem().map({ args0 -> args0 }).orElse(null),
            repositoryCredentials = javaType.repositoryCredentials().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionRepositoryCredentials.Companion.toKotlin(args0)
                })
            }).orElse(null),
            resourceRequirements = javaType.resourceRequirements().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionResourceRequirement.Companion.toKotlin(args0)
                })
            }),
            secrets = javaType.secrets().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionSecret.Companion.toKotlin(args0)
                })
            }),
            ulimits = javaType.ulimits().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionUlimit.Companion.toKotlin(args0)
                })
            }),
            user = javaType.user().map({ args0 -> args0 }).orElse(null),
        )
    }
}