Interface CfnJobDefinition.ContainerPropertiesProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnJobDefinition.ContainerPropertiesProperty.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; ContainerPropertiesProperty containerPropertiesProperty = ContainerPropertiesProperty.builder() .image("image") // the properties below are optional .command(List.of("command")) .environment(List.of(EnvironmentProperty.builder() .name("name") .value("value") .build())) .ephemeralStorage(EphemeralStorageProperty.builder() .sizeInGiB(123) .build()) .executionRoleArn("executionRoleArn") .fargatePlatformConfiguration(FargatePlatformConfigurationProperty.builder() .platformVersion("platformVersion") .build()) .instanceType("instanceType") .jobRoleArn("jobRoleArn") .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()) .memory(123) .mountPoints(List.of(MountPointsProperty.builder() .containerPath("containerPath") .readOnly(false) .sourceVolume("sourceVolume") .build())) .networkConfiguration(NetworkConfigurationProperty.builder() .assignPublicIp("assignPublicIp") .build()) .privileged(false) .readonlyRootFilesystem(false) .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") .vcpus(123) .volumes(List.of(VolumesProperty.builder() .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder() .fileSystemId("fileSystemId") // the properties below are optional .authorizationConfig(AuthorizationConfigProperty.builder() .accessPointId("accessPointId") .iam("iam") .build()) .rootDirectory("rootDirectory") .transitEncryption("transitEncryption") .transitEncryptionPort(123) .build()) .host(VolumesHostProperty.builder() .sourcePath("sourcePath") .build()) .name("name") .build())) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnJobDefinition.ContainerPropertiesProperty
static final class
An implementation forCfnJobDefinition.ContainerPropertiesProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The command that's passed to the container.default Object
The environment variables to pass to a container.default Object
CfnJobDefinition.ContainerPropertiesProperty.EphemeralStorage
.default String
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.default Object
The platform configuration for jobs that are running on Fargate resources.getImage()
The image used to start a container.default String
The instance type to use for a multi-node parallel job.default String
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.default Object
Linux-specific modifications that are applied to the container, such as details for device mappings.default Object
The log configuration specification for the container.default Number
This parameter is deprecated, useresourceRequirements
to specify the memory requirements for the job definition.default Object
The mount points for data volumes in your container.default Object
The network configuration for jobs that are running on Fargate resources.default Object
When this parameter is true, the container is given elevated permissions on the host container instance (similar to theroot
user).default Object
When this parameter is true, the container is given read-only access to its root file system.default Object
The type and amount of resources to assign to a container.default Object
The secrets for the container.default Object
A list ofulimits
to set in the container.default String
getUser()
The user name to use inside the container.default Number
getVcpus()
This parameter is deprecated, useresourceRequirements
to specify the vCPU requirements for the job definition.default Object
A list of data volumes used in a job.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. 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 toImage
in the Create a container section of the Docker Remote API and theIMAGE
parameter of docker 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]
orregistry/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.<region-name>.amazonaws.com/<repository-name>
). - Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). - 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
).
- Images in Amazon ECR Public repositories use the full
-
getCommand
The command that's passed to the container.This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd . -
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--env
option 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. -
getEphemeralStorage
CfnJobDefinition.ContainerPropertiesProperty.EphemeralStorage
. -
getExecutionRoleArn
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 in the AWS Batch User Guide .
-
getFargatePlatformConfiguration
The platform configuration for jobs that are running on Fargate resources.Jobs that are running on EC2 resources must not specify this parameter.
-
getInstanceType
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.
-
getJobRoleArn
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 in the Amazon Elastic Container Service Developer Guide .
-
getLinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings. -
getLogConfiguration
The log configuration specification for the container.This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker 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 in the Docker documentation.AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the
LogConfiguration
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 in the Amazon Elastic Container Service Developer Guide . -
getMemory
This parameter is deprecated, useresourceRequirements
to specify the memory requirements for the job definition.It's not supported for jobs running on Fargate resources. For jobs that run on 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.
-
getMountPoints
The mount points for data volumes in your container.This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run . -
getNetworkConfiguration
The network configuration for jobs that are running on Fargate resources.Jobs that are running on EC2 resources must not specify this parameter.
-
getPrivileged
When this parameter is true, the container is given elevated permissions on the host container instance (similar to theroot
user).This parameter maps to
Privileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker 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.
-
getReadonlyRootFilesystem
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 section of the Docker Remote API and the--read-only
option todocker run
. -
getResourceRequirements
The type and amount of resources to assign to a container.The supported resources include
GPU
,MEMORY
, andVCPU
. -
getSecrets
The secrets for the container.For more information, see Specifying sensitive data in the AWS Batch User Guide .
-
getUlimits
A list ofulimits
to set in the container.This parameter maps to
Ulimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run .This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
-
getUser
The user name 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 . -
getVcpus
This parameter is deprecated, useresourceRequirements
to specify the vCPU requirements for the job definition.It's not supported for jobs running on Fargate resources. For jobs running on 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 section of the Docker Remote API and the--cpu-shares
option to docker 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. -
getVolumes
A list of data volumes used in a job. -
builder
-