software.amazon.awscdk.services.batch

Interface CfnJobDefinition.ContainerPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(value=Stable)
public static interface CfnJobDefinition.ContainerPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

Container properties are used in job definitions 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()))
         .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

Nested Classes

Modifier and Type	Interface and Description
static class	CfnJobDefinition.ContainerPropertiesProperty.Builder A builder for CfnJobDefinition.ContainerPropertiesProperty
static class	CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy An implementation for CfnJobDefinition.ContainerPropertiesProperty

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.ContainerPropertiesProperty.Builder	builder()
default List<String>	getCommand() The command that's passed to the container.
default Object	getEnvironment() The environment variables to pass to a container.
default String	getExecutionRoleArn() The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
default Object	getFargatePlatformConfiguration() The platform configuration for jobs that are running on Fargate resources.
String	getImage() The image used to start a container.
default String	getInstanceType() The instance type to use for a multi-node parallel job.
default String	getJobRoleArn() The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
default Object	getLinuxParameters() Linux-specific modifications that are applied to the container, such as details for device mappings.
default Object	getLogConfiguration() The log configuration specification for the container.
default Number	getMemory() This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition.
default Object	getMountPoints() The mount points for data volumes in your container.
default Object	getNetworkConfiguration() The network configuration for jobs that are running on Fargate resources.
default Object	getPrivileged() When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user).
default Object	getReadonlyRootFilesystem() When this parameter is true, the container is given read-only access to its root file system.
default Object	getResourceRequirements() The type and amount of resources to assign to a container.
default Object	getSecrets() The secrets for the container.
default Object	getUlimits() A list of `ulimits` to set in the container.
default String	getUser() The user name to use inside the container.
default Number	getVcpus() This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition.
default Object	getVolumes() A list of data volumes used in a job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(value=Stable)
 @NotNull
String 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* . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE 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] 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, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name> ).
• 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 ).

getCommand

@Stability(value=Stable)
 @Nullable
default List<String> 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 the COMMAND parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd .

getEnvironment

@Stability(value=Stable)
 @Nullable
default Object 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 must not start with AWS_BATCH ; this naming convention is reserved for variables that are set by the AWS Batch service.

getExecutionRoleArn

@Stability(value=Stable)
 @Nullable
default String 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

@Stability(value=Stable)
 @Nullable
default Object 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

@Stability(value=Stable)
 @Nullable
default String 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

@Stability(value=Stable)
 @Nullable
default String 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

@Stability(value=Stable)
 @Nullable
default Object getLinuxParameters()

Linux-specific modifications that are applied to the container, such as details for device mappings.

getLogConfiguration

@Stability(value=Stable)
 @Nullable
default Object 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 into 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

@Stability(value=Stable)
 @Nullable
default Number getMemory()

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 running 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

@Stability(value=Stable)
 @Nullable
default Object 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

@Stability(value=Stable)
 @Nullable
default Object 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

@Stability(value=Stable)
 @Nullable
default Object getPrivileged()

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 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

@Stability(value=Stable)
 @Nullable
default Object 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 to docker run .

getResourceRequirements

@Stability(value=Stable)
 @Nullable
default Object getResourceRequirements()

The type and amount of resources to assign to a container.

The supported resources include GPU , MEMORY , and VCPU .

getSecrets

@Stability(value=Stable)
 @Nullable
default Object getSecrets()

The secrets for the container.

For more information, see Specifying sensitive data in the AWS Batch User Guide .

getUlimits

@Stability(value=Stable)
 @Nullable
default Object getUlimits()

A list of `ulimits` 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

@Stability(value=Stable)
 @Nullable
default String 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

@Stability(value=Stable)
 @Nullable
default Number getVcpus()

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 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

@Stability(value=Stable)
 @Nullable
default Object getVolumes()

A list of data volumes used in a job.

builder

@Stability(value=Stable)
static CfnJobDefinition.ContainerPropertiesProperty.Builder builder()

Returns:

a CfnJobDefinition.ContainerPropertiesProperty.Builder of CfnJobDefinition.ContainerPropertiesProperty