Interface CfnJobDefinition.TaskContainerPropertiesProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnJobDefinition.TaskContainerPropertiesProperty.Jsii$Proxy
- Enclosing class:
CfnJobDefinition
These properties to describe the container that's launched as part of a job.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.batch.*;
Object options;
TaskContainerPropertiesProperty taskContainerPropertiesProperty = TaskContainerPropertiesProperty.builder()
.image("image")
// the properties below are optional
.command(List.of("command"))
.dependsOn(List.of(TaskContainerDependencyProperty.builder()
.condition("condition")
.containerName("containerName")
.build()))
.environment(List.of(EnvironmentProperty.builder()
.name("name")
.value("value")
.build()))
.essential(false)
.firelensConfiguration(FirelensConfigurationProperty.builder()
.type("type")
// the properties below are optional
.options(Map.of(
"optionsKey", "options"))
.build())
.linuxParameters(LinuxParametersProperty.builder()
.devices(List.of(DeviceProperty.builder()
.containerPath("containerPath")
.hostPath("hostPath")
.permissions(List.of("permissions"))
.build()))
.initProcessEnabled(false)
.maxSwap(123)
.sharedMemorySize(123)
.swappiness(123)
.tmpfs(List.of(TmpfsProperty.builder()
.containerPath("containerPath")
.size(123)
// the properties below are optional
.mountOptions(List.of("mountOptions"))
.build()))
.build())
.logConfiguration(LogConfigurationProperty.builder()
.logDriver("logDriver")
// the properties below are optional
.options(options)
.secretOptions(List.of(SecretProperty.builder()
.name("name")
.valueFrom("valueFrom")
.build()))
.build())
.mountPoints(List.of(MountPointProperty.builder()
.containerPath("containerPath")
.readOnly(false)
.sourceVolume("sourceVolume")
.build()))
.name("name")
.privileged(false)
.readonlyRootFilesystem(false)
.repositoryCredentials(RepositoryCredentialsProperty.builder()
.credentialsParameter("credentialsParameter")
.build())
.resourceRequirements(List.of(ResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.secrets(List.of(SecretProperty.builder()
.name("name")
.valueFrom("valueFrom")
.build()))
.ulimits(List.of(UlimitProperty.builder()
.hardLimit(123)
.name("name")
.softLimit(123)
.build()))
.user("user")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnJobDefinition.TaskContainerPropertiesPropertystatic final classAn implementation forCfnJobDefinition.TaskContainerPropertiesProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The command that's passed to the container.default ObjectA list of containers that this container depends on.default ObjectThe environment variables to pass to a container.default ObjectIf the essential parameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.default ObjectThe FireLens configuration for the container.getImage()The image used to start a container.default ObjectLinux-specific modifications that are applied to the container, such as Linux kernel capabilities.default ObjectThe log configuration specification for the container.default ObjectThe mount points for data volumes in your container.default StringgetName()The name of a container.default ObjectWhen this parameter istrue, the container is given elevated privileges on the host container instance (similar to therootuser).default ObjectWhen this parameter is true, the container is given read-only access to its root file system.default ObjectThe private repository authentication credentials to use.default ObjectThe type and amount of a resource to assign to a container.default ObjectThe secrets to pass to the container.default ObjectA list ofulimitsto set in the container.default StringgetUser()The user to use inside the container.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getImage
The image used to start a container.This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of the docker run .- See Also:
-
getCommand
The command that's passed to the container.This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run . For more information, see Dockerfile reference: CMD .- See Also:
-
getDependsOn
A list of containers that this container depends on.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.TaskContainerDependencyProperty>- See Also:
-
getEnvironment
The environment variables to pass to a container.This parameter maps to Env in the Create a container section of the Docker Remote API and the
--envparameter to docker 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.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.EnvironmentProperty>- See Also:
-
getEssential
If the essential parameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.If the
essentialparameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .
Returns union: either
BooleanorIResolvable- See Also:
-
getFirelensConfiguration
The FireLens configuration for the container.This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide .
Returns union: either
IResolvableorCfnJobDefinition.FirelensConfigurationProperty- See Also:
-
getLinuxParameters
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.For more information, see KernelCapabilities .
Returns union: either
IResolvableorCfnJobDefinition.LinuxParametersProperty- See Also:
-
getLogConfiguration
The log configuration specification for the container.This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run .By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation .
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the
LogConfigurationdata type). Additional log drivers may be available in future releases of the Amazon ECS container agent.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version
--format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .Returns union: either
IResolvableorCfnJobDefinition.LogConfigurationProperty- See Also:
-
getMountPoints
The mount points for data volumes in your container.This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the --volume option to docker run .Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.MountPointProperty>- See Also:
-
getName
The name of a container.The name can be used as a unique identifier to target your
dependsOnandOverridesobjects.- See Also:
-
getPrivileged
When this parameter istrue, the container is given elevated privileges on the host container instance (similar to therootuser).This parameter maps to
Privilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run .This parameter is not supported for Windows containers or tasks run on Fargate.
Returns union: either
BooleanorIResolvable- See Also:
-
getReadonlyRootFilesystem
When this parameter is true, the container is given read-only access to its root file system.This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run .This parameter is not supported for Windows containers.
Returns union: either
BooleanorIResolvable- See Also:
-
getRepositoryCredentials
The private repository authentication credentials to use.Returns union: either
IResolvableorCfnJobDefinition.RepositoryCredentialsProperty- See Also:
-
getResourceRequirements
The type and amount of a resource to assign to a container.The only supported resource is a GPU.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.ResourceRequirementProperty>- See Also:
-
getSecrets
The secrets to pass to the container.For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.SecretProperty>- See Also:
-
getUlimits
A list ofulimitsto set in the container.If a
ulimitvalue is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run .Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The
nofileresource limit sets a restriction on the number of open files that a container can use. The defaultnofilesoft limit is1024and the default hard limit is65535.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version
--format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.UlimitProperty>- See Also:
-
getUser
The user to use inside the container.This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
When running tasks using the
hostnetwork mode, don't run containers using theroot user (UID 0). We recommend using a non-root user for better security.You can specify the
userusing the following formats. If specifying a UID or GID, you must specify it as a positive integer.useruser:groupuiduid:giduser:giuid:group
This parameter is not supported for Windows containers.
- See Also:
-
builder
-