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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

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

import kotlin.Boolean
import kotlin.Int
import kotlin.Suppress
import kotlin.collections.List

/**
 *
 * @property devices Any of the host devices to expose to the container. This parameter maps to `Devices` 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 `--device` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
 * > This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
 * @property initProcessEnabled If true, run an `init` process inside the container that forwards signals and reaps processes. This parameter maps to the `--init` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . This parameter requires version 1.25 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 | grep "Server API version"`
 * @property maxSwap The total amount of swap memory (in MiB) a container can use. This parameter is translated to the `--memory-swap` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) where the value is the sum of the container memory plus the `maxSwap` value. For more information, see [`--memory-swap` details](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details) in the Docker documentation.
 * If a `maxSwap` value of `0` is specified, the container doesn't use swap. Accepted values are `0` or any positive integer. If the `maxSwap` parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A `maxSwap` value must be set for the `swappiness` parameter to be used.
 * > This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
 * @property sharedMemorySize The value for the size (in MiB) of the `/dev/shm` volume. This parameter maps to the `--shm-size` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
 * > This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
 * @property swappiness You can use this parameter to tune a container's memory swappiness behavior. A `swappiness` value of `0` causes swapping to not occur unless absolutely necessary. A `swappiness` value of `100` causes pages to be swapped aggressively. Valid values are whole numbers between `0` and `100` . If the `swappiness` parameter isn't specified, a default value of `60` is used. If a value isn't specified for `maxSwap` , then this parameter is ignored. If `maxSwap` is set to 0, the container doesn't use swap. This parameter maps to the `--memory-swappiness` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
 * Consider the following when you use a per-container swap configuration.
 * - Swap space must be enabled and allocated on the container instance for the containers to use.
 * > By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see [Instance store swap volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) in the *Amazon EC2 User Guide for Linux Instances* or [How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/)
 * - The swap space parameters are only supported for job definitions using EC2 resources.
 * - If the `maxSwap` and `swappiness` parameters are omitted from a job definition, each container has a default `swappiness` value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
 * > This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
 * @property tmpfs The container path, mount options, and size (in MiB) of the `tmpfs` mount. This parameter maps to the `--tmpfs` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
 * > This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
 */
public data class JobDefinitionLinuxParameters(
    public val devices: List? = null,
    public val initProcessEnabled: Boolean? = null,
    public val maxSwap: Int? = null,
    public val sharedMemorySize: Int? = null,
    public val swappiness: Int? = null,
    public val tmpfs: List? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.batch.outputs.JobDefinitionLinuxParameters): JobDefinitionLinuxParameters = JobDefinitionLinuxParameters(
            devices = javaType.devices().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionDevice.Companion.toKotlin(args0)
                })
            }),
            initProcessEnabled = javaType.initProcessEnabled().map({ args0 -> args0 }).orElse(null),
            maxSwap = javaType.maxSwap().map({ args0 -> args0 }).orElse(null),
            sharedMemorySize = javaType.sharedMemorySize().map({ args0 -> args0 }).orElse(null),
            swappiness = javaType.swappiness().map({ args0 -> args0 }).orElse(null),
            tmpfs = javaType.tmpfs().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionTmpfs.Companion.toKotlin(args0)
                })
            }),
        )
    }
}