com.pulumi.awsnative.ecs.kotlin.TaskDefinitionArgs.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.ecs.kotlin
import com.pulumi.awsnative.ecs.TaskDefinitionArgs.builder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionContainerDefinitionArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionContainerDefinitionArgsBuilder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionEphemeralStorageArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionEphemeralStorageArgsBuilder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionInferenceAcceleratorArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionInferenceAcceleratorArgsBuilder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionPlacementConstraintArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionPlacementConstraintArgsBuilder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionProxyConfigurationArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionProxyConfigurationArgsBuilder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionRuntimePlatformArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionRuntimePlatformArgsBuilder
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionVolumeArgs
import com.pulumi.awsnative.ecs.kotlin.inputs.TaskDefinitionVolumeArgsBuilder
import com.pulumi.awsnative.kotlin.inputs.TagArgs
import com.pulumi.awsnative.kotlin.inputs.TagArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
* You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
* You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
* In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
* You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
* ## Example Usage
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* @property containerDefinitions A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
* @property cpu The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.
* The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
* + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
* + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
* + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
* + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
* + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
* + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments
* This option requires Linux platform ``1.4.0`` or later.
* + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments
* This option requires Linux platform ``1.4.0`` or later.
* @property ephemeralStorage The ephemeral storage settings to use for tasks run with the task definition.
* @property executionRoleArn The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
* @property family The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
* A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
* To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
* @property inferenceAccelerators The Elastic Inference accelerators to use for the containers in the task.
* @property ipcMode The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.
* If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
* If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
* + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.
* + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.
* This parameter is not supported for Windows containers or tasks run on FARGATElong.
* @property memory The amount (in MiB) of memory used by the task.
* If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
* If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.
* + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)
* + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)
* + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)
* + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)
* + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)
* + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)
* This option requires Linux platform ``1.4.0`` or later.
* + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)
* This option requires Linux platform ``1.4.0`` or later.
* @property networkMode The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.
* For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.
* With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings.
* When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
* If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
* If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
* For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
* @property pidMode The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.
* If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
* If ``task`` is specified, all containers within the specified task share the same process namespace.
* If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.
* If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
* This parameter is not supported for Windows containers.
* This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
* @property placementConstraints An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
* @property proxyConfiguration The configuration details for the App Mesh proxy.
* Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, 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*.
* @property requiresCompatibilities The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
* @property runtimePlatform The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
* @property tags The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
* @property taskRoleArn The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
* @property volumes The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
public data class TaskDefinitionArgs(
public val containerDefinitions: Output>? = null,
public val cpu: Output? = null,
public val ephemeralStorage: Output? = null,
public val executionRoleArn: Output? = null,
public val family: Output? = null,
public val inferenceAccelerators: Output>? = null,
public val ipcMode: Output? = null,
public val memory: Output? = null,
public val networkMode: Output? = null,
public val pidMode: Output? = null,
public val placementConstraints: Output>? = null,
public val proxyConfiguration: Output? = null,
public val requiresCompatibilities: Output>? = null,
public val runtimePlatform: Output? = null,
public val tags: Output>? = null,
public val taskRoleArn: Output? = null,
public val volumes: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.ecs.TaskDefinitionArgs =
com.pulumi.awsnative.ecs.TaskDefinitionArgs.builder()
.containerDefinitions(
containerDefinitions?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.cpu(cpu?.applyValue({ args0 -> args0 }))
.ephemeralStorage(ephemeralStorage?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.executionRoleArn(executionRoleArn?.applyValue({ args0 -> args0 }))
.family(family?.applyValue({ args0 -> args0 }))
.inferenceAccelerators(
inferenceAccelerators?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.ipcMode(ipcMode?.applyValue({ args0 -> args0 }))
.memory(memory?.applyValue({ args0 -> args0 }))
.networkMode(networkMode?.applyValue({ args0 -> args0 }))
.pidMode(pidMode?.applyValue({ args0 -> args0 }))
.placementConstraints(
placementConstraints?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.proxyConfiguration(
proxyConfiguration?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.requiresCompatibilities(
requiresCompatibilities?.applyValue({ args0 ->
args0.map({ args0 ->
args0
})
}),
)
.runtimePlatform(runtimePlatform?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.let({ args0 -> args0.toJava() }) }) }))
.taskRoleArn(taskRoleArn?.applyValue({ args0 -> args0 }))
.volumes(
volumes?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
).build()
}
/**
* Builder for [TaskDefinitionArgs].
*/
@PulumiTagMarker
public class TaskDefinitionArgsBuilder internal constructor() {
private var containerDefinitions: Output>? = null
private var cpu: Output? = null
private var ephemeralStorage: Output? = null
private var executionRoleArn: Output? = null
private var family: Output? = null
private var inferenceAccelerators: Output>? = null
private var ipcMode: Output? = null
private var memory: Output? = null
private var networkMode: Output? = null
private var pidMode: Output? = null
private var placementConstraints: Output>? = null
private var proxyConfiguration: Output? = null
private var requiresCompatibilities: Output>? = null
private var runtimePlatform: Output? = null
private var tags: Output>? = null
private var taskRoleArn: Output? = null
private var volumes: Output>? = null
/**
* @param value A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("ofnqkcwaowrgjwpo")
public suspend fun containerDefinitions(`value`: Output>) {
this.containerDefinitions = value
}
@JvmName("actunpqdfanlbttm")
public suspend fun containerDefinitions(vararg values: Output) {
this.containerDefinitions = Output.all(values.asList())
}
/**
* @param values A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("aqnytbmgxlaffxor")
public suspend fun containerDefinitions(values: List>) {
this.containerDefinitions = Output.all(values)
}
/**
* @param value The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.
* The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
* + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
* + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
* + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
* + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
* + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
* + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments
* This option requires Linux platform ``1.4.0`` or later.
* + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments
* This option requires Linux platform ``1.4.0`` or later.
*/
@JvmName("ftxrmxoywphektrk")
public suspend fun cpu(`value`: Output) {
this.cpu = value
}
/**
* @param value The ephemeral storage settings to use for tasks run with the task definition.
*/
@JvmName("kfsxcckvoiqwfelr")
public suspend fun ephemeralStorage(`value`: Output) {
this.ephemeralStorage = value
}
/**
* @param value The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("btbjklosvvmnvwgi")
public suspend fun executionRoleArn(`value`: Output) {
this.executionRoleArn = value
}
/**
* @param value The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
* A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
* To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
*/
@JvmName("qsvmbpctchayecmx")
public suspend fun family(`value`: Output) {
this.family = value
}
/**
* @param value The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("ukqemumujliflqtr")
public suspend fun inferenceAccelerators(`value`: Output>) {
this.inferenceAccelerators = value
}
@JvmName("uhvtlbbrkoyujiin")
public suspend fun inferenceAccelerators(vararg values: Output) {
this.inferenceAccelerators = Output.all(values.asList())
}
/**
* @param values The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("pduvcgqjsfkhqpgh")
public suspend fun inferenceAccelerators(values: List>) {
this.inferenceAccelerators = Output.all(values)
}
/**
* @param value The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.
* If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
* If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
* + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.
* + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.
* This parameter is not supported for Windows containers or tasks run on FARGATElong.
*/
@JvmName("dteofdgyysbynsaf")
public suspend fun ipcMode(`value`: Output) {
this.ipcMode = value
}
/**
* @param value The amount (in MiB) of memory used by the task.
* If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
* If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.
* + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)
* + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)
* + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)
* + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)
* + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)
* + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)
* This option requires Linux platform ``1.4.0`` or later.
* + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)
* This option requires Linux platform ``1.4.0`` or later.
*/
@JvmName("okktyxhmxwfujtdd")
public suspend fun memory(`value`: Output) {
this.memory = value
}
/**
* @param value The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.
* For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.
* With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings.
* When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
* If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
* If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
* For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
*/
@JvmName("tmklxqbnjfiweclx")
public suspend fun networkMode(`value`: Output) {
this.networkMode = value
}
/**
* @param value The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.
* If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
* If ``task`` is specified, all containers within the specified task share the same process namespace.
* If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.
* If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
* This parameter is not supported for Windows containers.
* This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
*/
@JvmName("bwxlghrsumvgcvee")
public suspend fun pidMode(`value`: Output) {
this.pidMode = value
}
/**
* @param value An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("dxwoluyrsnwtmesg")
public suspend fun placementConstraints(`value`: Output>) {
this.placementConstraints = value
}
@JvmName("otfecxigfgqugpnd")
public suspend fun placementConstraints(vararg values: Output) {
this.placementConstraints = Output.all(values.asList())
}
/**
* @param values An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("ichnhrjcghdufugs")
public suspend fun placementConstraints(values: List>) {
this.placementConstraints = Output.all(values)
}
/**
* @param value The configuration details for the App Mesh proxy.
* Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, 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*.
*/
@JvmName("scpjjeylsfkbspoi")
public suspend fun proxyConfiguration(`value`: Output) {
this.proxyConfiguration = value
}
/**
* @param value The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("hqanuujijwgcpclk")
public suspend fun requiresCompatibilities(`value`: Output>) {
this.requiresCompatibilities = value
}
@JvmName("bvjyeptxqcqbbtmt")
public suspend fun requiresCompatibilities(vararg values: Output) {
this.requiresCompatibilities = Output.all(values.asList())
}
/**
* @param values The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("alfcptnaecpvghre")
public suspend fun requiresCompatibilities(values: List>) {
this.requiresCompatibilities = Output.all(values)
}
/**
* @param value The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
*/
@JvmName("xpvdiuhgyalfkxhi")
public suspend fun runtimePlatform(`value`: Output) {
this.runtimePlatform = value
}
/**
* @param value The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("nscrmfrqsqpydxsh")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
@JvmName("qtgojkeslnihyuca")
public suspend fun tags(vararg values: Output) {
this.tags = Output.all(values.asList())
}
/**
* @param values The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("kucembxvhrgcqdto")
public suspend fun tags(values: List>) {
this.tags = Output.all(values)
}
/**
* @param value The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("cicynkyjdmvjojyy")
public suspend fun taskRoleArn(`value`: Output) {
this.taskRoleArn = value
}
/**
* @param value The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("hhdbjcuridckhrsa")
public suspend fun volumes(`value`: Output>) {
this.volumes = value
}
@JvmName("hpxbxbfmrqirgbup")
public suspend fun volumes(vararg values: Output) {
this.volumes = Output.all(values.asList())
}
/**
* @param values The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("thaotwqnjmlpcqgk")
public suspend fun volumes(values: List>) {
this.volumes = Output.all(values)
}
/**
* @param value A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("cblypemhixyipbas")
public suspend fun containerDefinitions(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.containerDefinitions = mapped
}
/**
* @param argument A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("wfbcbsncogagpvit")
public suspend fun containerDefinitions(argument: List Unit>) {
val toBeMapped = argument.toList().map {
TaskDefinitionContainerDefinitionArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.containerDefinitions = mapped
}
/**
* @param argument A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("qtcrdkpwsvdsdqqa")
public suspend fun containerDefinitions(vararg argument: suspend TaskDefinitionContainerDefinitionArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
TaskDefinitionContainerDefinitionArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.containerDefinitions = mapped
}
/**
* @param argument A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("hlchktopdvmwntge")
public suspend fun containerDefinitions(argument: suspend TaskDefinitionContainerDefinitionArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
TaskDefinitionContainerDefinitionArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.containerDefinitions = mapped
}
/**
* @param values A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("qgdumpdwxpbutvyp")
public suspend fun containerDefinitions(vararg values: TaskDefinitionContainerDefinitionArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.containerDefinitions = mapped
}
/**
* @param value The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.
* The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
* + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
* + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
* + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
* + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
* + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
* + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments
* This option requires Linux platform ``1.4.0`` or later.
* + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments
* This option requires Linux platform ``1.4.0`` or later.
*/
@JvmName("wgdyxlatuegvwppd")
public suspend fun cpu(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.cpu = mapped
}
/**
* @param value The ephemeral storage settings to use for tasks run with the task definition.
*/
@JvmName("yundukdsovegrbee")
public suspend fun ephemeralStorage(`value`: TaskDefinitionEphemeralStorageArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.ephemeralStorage = mapped
}
/**
* @param argument The ephemeral storage settings to use for tasks run with the task definition.
*/
@JvmName("wvfqeovuuyuaqeia")
public suspend fun ephemeralStorage(argument: suspend TaskDefinitionEphemeralStorageArgsBuilder.() -> Unit) {
val toBeMapped = TaskDefinitionEphemeralStorageArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.ephemeralStorage = mapped
}
/**
* @param value The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("cjrknfrdjeqgkhya")
public suspend fun executionRoleArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.executionRoleArn = mapped
}
/**
* @param value The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
* A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
* To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
*/
@JvmName("cdlsmribdokbarir")
public suspend fun family(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.family = mapped
}
/**
* @param value The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("dvdasqkdmlwkurwh")
public suspend fun inferenceAccelerators(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.inferenceAccelerators = mapped
}
/**
* @param argument The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("adkbknalesdimrif")
public suspend fun inferenceAccelerators(argument: List Unit>) {
val toBeMapped = argument.toList().map {
TaskDefinitionInferenceAcceleratorArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.inferenceAccelerators = mapped
}
/**
* @param argument The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("mrvojyarrwythdhe")
public suspend fun inferenceAccelerators(vararg argument: suspend TaskDefinitionInferenceAcceleratorArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
TaskDefinitionInferenceAcceleratorArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.inferenceAccelerators = mapped
}
/**
* @param argument The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("qnjyukonraqryudn")
public suspend fun inferenceAccelerators(argument: suspend TaskDefinitionInferenceAcceleratorArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
TaskDefinitionInferenceAcceleratorArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.inferenceAccelerators = mapped
}
/**
* @param values The Elastic Inference accelerators to use for the containers in the task.
*/
@JvmName("wlaewweawgyctmtf")
public suspend fun inferenceAccelerators(vararg values: TaskDefinitionInferenceAcceleratorArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.inferenceAccelerators = mapped
}
/**
* @param value The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.
* If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
* If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
* + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.
* + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.
* This parameter is not supported for Windows containers or tasks run on FARGATElong.
*/
@JvmName("nxqtpnoydtslxxbh")
public suspend fun ipcMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.ipcMode = mapped
}
/**
* @param value The amount (in MiB) of memory used by the task.
* If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
* If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.
* + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)
* + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)
* + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)
* + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)
* + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)
* + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)
* This option requires Linux platform ``1.4.0`` or later.
* + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)
* This option requires Linux platform ``1.4.0`` or later.
*/
@JvmName("yvkskhpcnngavyuu")
public suspend fun memory(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.memory = mapped
}
/**
* @param value The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.
* For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.
* With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings.
* When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
* If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
* If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
* For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
*/
@JvmName("qbdydgswrlnplnmm")
public suspend fun networkMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.networkMode = mapped
}
/**
* @param value The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.
* If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
* If ``task`` is specified, all containers within the specified task share the same process namespace.
* If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.
* If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
* This parameter is not supported for Windows containers.
* This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
*/
@JvmName("uptrkwmrukolmybh")
public suspend fun pidMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.pidMode = mapped
}
/**
* @param value An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("aanoquhdxquocdle")
public suspend fun placementConstraints(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.placementConstraints = mapped
}
/**
* @param argument An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("gvpogpnoplhjnper")
public suspend fun placementConstraints(argument: List Unit>) {
val toBeMapped = argument.toList().map {
TaskDefinitionPlacementConstraintArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.placementConstraints = mapped
}
/**
* @param argument An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("dlsskafxxwmillgl")
public suspend fun placementConstraints(vararg argument: suspend TaskDefinitionPlacementConstraintArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
TaskDefinitionPlacementConstraintArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.placementConstraints = mapped
}
/**
* @param argument An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("ebwljphcxgroqjmm")
public suspend fun placementConstraints(argument: suspend TaskDefinitionPlacementConstraintArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
TaskDefinitionPlacementConstraintArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.placementConstraints = mapped
}
/**
* @param values An array of placement constraint objects to use for tasks.
* This parameter isn't supported for tasks run on FARGATElong.
*/
@JvmName("cnhtrknrfnpdtgih")
public suspend fun placementConstraints(vararg values: TaskDefinitionPlacementConstraintArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.placementConstraints = mapped
}
/**
* @param value The configuration details for the App Mesh proxy.
* Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, 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*.
*/
@JvmName("kcrspdljxyixpply")
public suspend fun proxyConfiguration(`value`: TaskDefinitionProxyConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.proxyConfiguration = mapped
}
/**
* @param argument The configuration details for the App Mesh proxy.
* Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, 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*.
*/
@JvmName("nuwieyppgmpsiikc")
public suspend fun proxyConfiguration(argument: suspend TaskDefinitionProxyConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = TaskDefinitionProxyConfigurationArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.proxyConfiguration = mapped
}
/**
* @param value The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("ejrkrtkyvhvwoovo")
public suspend fun requiresCompatibilities(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requiresCompatibilities = mapped
}
/**
* @param values The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("oecrfxhctbemjixh")
public suspend fun requiresCompatibilities(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.requiresCompatibilities = mapped
}
/**
* @param value The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
*/
@JvmName("xcfmxarplsslrtai")
public suspend fun runtimePlatform(`value`: TaskDefinitionRuntimePlatformArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.runtimePlatform = mapped
}
/**
* @param argument The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
*/
@JvmName("aehbqcglhwkjmtwm")
public suspend fun runtimePlatform(argument: suspend TaskDefinitionRuntimePlatformArgsBuilder.() -> Unit) {
val toBeMapped = TaskDefinitionRuntimePlatformArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.runtimePlatform = mapped
}
/**
* @param value The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("pjwpnepxybigdidj")
public suspend fun tags(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param argument The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("heavryogpwqnttnr")
public suspend fun tags(argument: List Unit>) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("wapviyjohikrmfsu")
public suspend fun tags(vararg argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("epsktxfrsxpdcrch")
public suspend fun tags(argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TagArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param values The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
@JvmName("myrxaucgpmjhbqoj")
public suspend fun tags(vararg values: TagArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
@JvmName("jrxrxifqbyjyldgu")
public suspend fun taskRoleArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.taskRoleArn = mapped
}
/**
* @param value The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("ewsnegqhhyjqkgle")
public suspend fun volumes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.volumes = mapped
}
/**
* @param argument The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("pkkwyqihgmrjhfqe")
public suspend fun volumes(argument: List Unit>) {
val toBeMapped = argument.toList().map {
TaskDefinitionVolumeArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.volumes = mapped
}
/**
* @param argument The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("xwrvmumxvggktspa")
public suspend fun volumes(vararg argument: suspend TaskDefinitionVolumeArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
TaskDefinitionVolumeArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.volumes = mapped
}
/**
* @param argument The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("rikiahfwgjxwlyhc")
public suspend fun volumes(argument: suspend TaskDefinitionVolumeArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TaskDefinitionVolumeArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.volumes = mapped
}
/**
* @param values The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
* The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.
*/
@JvmName("pfhiiolbnjdkvwse")
public suspend fun volumes(vararg values: TaskDefinitionVolumeArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.volumes = mapped
}
internal fun build(): TaskDefinitionArgs = TaskDefinitionArgs(
containerDefinitions = containerDefinitions,
cpu = cpu,
ephemeralStorage = ephemeralStorage,
executionRoleArn = executionRoleArn,
family = family,
inferenceAccelerators = inferenceAccelerators,
ipcMode = ipcMode,
memory = memory,
networkMode = networkMode,
pidMode = pidMode,
placementConstraints = placementConstraints,
proxyConfiguration = proxyConfiguration,
requiresCompatibilities = requiresCompatibilities,
runtimePlatform = runtimePlatform,
tags = tags,
taskRoleArn = taskRoleArn,
volumes = volumes,
)
}