com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionContainerProperties.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.batch.kotlin.outputs
import kotlin.Boolean
import kotlin.Int
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 [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) .
* @property environment The environment variables to pass to a container. This parameter maps to `Env` 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 `--env` option 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 ephemeralStorage The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .
* @property executionRoleArn The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the *AWS Batch User Guide* .
* @property fargatePlatformConfiguration The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
* @property image Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `*repository-url* / *image* : *tag*` . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to `Image` 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 `IMAGE` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
* > Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
* - Images in Amazon ECR Public repositories use the full `registry/repository[:tag]` or `registry/repository[@digest]` naming conventions. For example, `public.ecr.aws/ *registry_alias* / *my-web-app* : *latest*` .
* - Images in Amazon ECR repositories use the full registry and repository URI (for example, `123456789012.dkr.ecr..amazonaws.com/` ).
* - Images in official repositories on Docker Hub use a single name (for example, `ubuntu` or `mongo` ).
* - Images in other repositories on Docker Hub are qualified with an organization name (for example, `amazon/amazon-ecs-agent` ).
* - Images in other online repositories are qualified further by a domain name (for example, `quay.io/assemblyline/ubuntu` ).
* @property instanceType The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
* > This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
* @property jobRoleArn The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. 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* .
* @property linuxParameters Linux-specific modifications that are applied to the container, such as details for device mappings.
* @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.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 `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . By default, containers use the same logging driver that the Docker daemon uses. However the container might 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 on 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.
* > AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) data type).
* 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 | grep "Server API version"`
* > 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 memory This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
* @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.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 `--volume` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
* @property networkConfiguration The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
* @property privileged When this parameter is true, the container is given elevated permissions 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.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 `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The default value is false.
* > This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
* @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.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 `--read-only` option to `docker run` .
* @property repositoryCredentials The private repository authentication credentials to use.
* @property resourceRequirements The type and amount of resources to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` .
* @property runtimePlatform An object that represents the compute environment architecture for AWS Batch jobs on Fargate.
* @property secrets The secrets for the container. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* .
* @property ulimits A list of `ulimits` to set in the container. This parameter maps to `Ulimits` 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 `--ulimit` 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 and shouldn't be provided.
* @property user The user name to use inside the container. This parameter maps to `User` 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 `--user` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .
* @property vcpus This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.
* Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to `CpuShares` 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 `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.
* @property volumes A list of data volumes used in a job.
*/
public data class JobDefinitionContainerProperties(
public val command: List? = null,
public val environment: List? = null,
public val ephemeralStorage: JobDefinitionEphemeralStorage? = null,
public val executionRoleArn: String? = null,
public val fargatePlatformConfiguration: JobDefinitionFargatePlatformConfiguration? = null,
public val image: String,
public val instanceType: String? = null,
public val jobRoleArn: String? = null,
public val linuxParameters: JobDefinitionLinuxParameters? = null,
public val logConfiguration: JobDefinitionLogConfiguration? = null,
public val memory: Int? = null,
public val mountPoints: List? = null,
public val networkConfiguration: JobDefinitionNetworkConfiguration? = null,
public val privileged: Boolean? = null,
public val readonlyRootFilesystem: Boolean? = null,
public val repositoryCredentials: JobDefinitionRepositoryCredentials? = null,
public val resourceRequirements: List? = null,
public val runtimePlatform: JobDefinitionRuntimePlatform? = null,
public val secrets: List? = null,
public val ulimits: List? = null,
public val user: String? = null,
public val vcpus: Int? = null,
public val volumes: List? = null,
) {
public companion object {
public fun toKotlin(javaType: com.pulumi.awsnative.batch.outputs.JobDefinitionContainerProperties): JobDefinitionContainerProperties = JobDefinitionContainerProperties(
command = javaType.command().map({ args0 -> args0 }),
environment = javaType.environment().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionEnvironment.Companion.toKotlin(args0)
})
}),
ephemeralStorage = javaType.ephemeralStorage().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionEphemeralStorage.Companion.toKotlin(args0)
})
}).orElse(null),
executionRoleArn = javaType.executionRoleArn().map({ args0 -> args0 }).orElse(null),
fargatePlatformConfiguration = javaType.fargatePlatformConfiguration().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionFargatePlatformConfiguration.Companion.toKotlin(args0)
})
}).orElse(null),
image = javaType.image(),
instanceType = javaType.instanceType().map({ args0 -> args0 }).orElse(null),
jobRoleArn = javaType.jobRoleArn().map({ args0 -> args0 }).orElse(null),
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),
memory = javaType.memory().map({ args0 -> args0 }).orElse(null),
mountPoints = javaType.mountPoints().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionMountPoints.Companion.toKotlin(args0)
})
}),
networkConfiguration = javaType.networkConfiguration().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionNetworkConfiguration.Companion.toKotlin(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)
})
}),
runtimePlatform = javaType.runtimePlatform().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionRuntimePlatform.Companion.toKotlin(args0)
})
}).orElse(null),
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),
vcpus = javaType.vcpus().map({ args0 -> args0 }).orElse(null),
volumes = javaType.volumes().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.batch.kotlin.outputs.JobDefinitionVolumes.Companion.toKotlin(args0)
})
}),
)
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy