ContainerPropertiesProperty Struct
Container properties are used for Amazon ECS based job definitions.
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 { aws_batch as batch } from 'aws-cdk-lib';
declare const options: any;
const containerPropertiesProperty: batch.CfnJobDefinition.ContainerPropertiesProperty = {
image: 'image',
// the properties below are optional
command: ['command'],
enableExecuteCommand: false,
environment: [{
name: 'name',
value: 'value',
}],
ephemeralStorage: {
sizeInGiB: 123,
},
executionRoleArn: 'executionRoleArn',
fargatePlatformConfiguration: {
platformVersion: 'platformVersion',
},
instanceType: 'instanceType',
jobRoleArn: 'jobRoleArn',
linuxParameters: {
devices: [{
containerPath: 'containerPath',
hostPath: 'hostPath',
permissions: ['permissions'],
}],
initProcessEnabled: false,
maxSwap: 123,
sharedMemorySize: 123,
swappiness: 123,
tmpfs: [{
containerPath: 'containerPath',
size: 123,
// the properties below are optional
mountOptions: ['mountOptions'],
}],
},
logConfiguration: {
logDriver: 'logDriver',
// the properties below are optional
options: options,
secretOptions: [{
name: 'name',
valueFrom: 'valueFrom',
}],
},
memory: 123,
mountPoints: [{
containerPath: 'containerPath',
readOnly: false,
sourceVolume: 'sourceVolume',
}],
networkConfiguration: {
assignPublicIp: 'assignPublicIp',
},
privileged: false,
readonlyRootFilesystem: false,
repositoryCredentials: {
credentialsParameter: 'credentialsParameter',
},
resourceRequirements: [{
type: 'type',
value: 'value',
}],
runtimePlatform: {
cpuArchitecture: 'cpuArchitecture',
operatingSystemFamily: 'operatingSystemFamily',
},
secrets: [{
name: 'name',
valueFrom: 'valueFrom',
}],
ulimits: [{
hardLimit: 123,
name: 'name',
softLimit: 123,
}],
user: 'user',
vcpus: 123,
volumes: [{
efsVolumeConfiguration: {
fileSystemId: 'fileSystemId',
// the properties below are optional
authorizationConfig: {
accessPointId: 'accessPointId',
iam: 'iam',
},
rootDirectory: 'rootDirectory',
transitEncryption: 'transitEncryption',
transitEncryptionPort: 123,
},
host: {
sourcePath: 'sourcePath',
},
name: 'name',
s3FilesVolumeConfiguration: {
fileSystemArn: 'fileSystemArn',
// the properties below are optional
accessPointArn: 'accessPointArn',
rootDirectory: 'rootDirectory',
transitEncryptionPort: 123,
},
}],
};
Properties
notes
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 .
enableExecuteCommandboolean | IResolvableenable_execute_commandtyping.Union[bool, IResolvable]enableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommandinterface{}#If true , execute command functionality is turned on all the containers in the task.
environmentIResolvable | IResolvable | CfnJobDefinition.EnvironmentProperty[]environmenttyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvironmentProperty]]]environmentIResolvableEnvironmentIResolvableEnvironmentinterface{}#notes
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.
ephemeralStorageIResolvable | CfnJobDefinition.EphemeralStoragePropertyephemeral_storagetyping.Union[IResolvable, EphemeralStorageProperty]ephemeralStorageIResolvableEphemeralStorageIResolvableEphemeralStorageinterface{}#This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .
executionRoleArnstringexecution_role_arnstrexecutionRoleArnStringExecutionRoleArnstringExecutionRoleArn*string#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 .
fargatePlatformConfigurationIResolvable | CfnJobDefinition.FargatePlatformConfigurationPropertyfargate_platform_configurationtyping.Union[IResolvable, FargatePlatformConfigurationProperty]fargatePlatformConfigurationIResolvableFargatePlatformConfigurationIResolvableFargatePlatformConfigurationinterface{}#Jobs that are running on Amazon EC2 resources must not specify this parameter.
notes
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 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]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,
ubuntuormongo). - 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).
For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide .
linuxParametersIResolvable | CfnJobDefinition.LinuxParametersPropertylinux_parameterstyping.Union[IResolvable, LinuxParametersProperty]linuxParametersIResolvableLinuxParametersIResolvableLinuxParametersinterface{}#logConfigurationIResolvable | CfnJobDefinition.LogConfigurationPropertylog_configurationtyping.Union[IResolvable, LogConfigurationProperty]logConfigurationIResolvableLogConfigurationIResolvableLogConfigurationinterface{}#notes
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_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 .
notes
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.
mountPointsIResolvable | IResolvable | CfnJobDefinition.MountPointsProperty[]mount_pointstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MountPointsProperty]]]mountPointsIResolvableMountPointsIResolvableMountPointsinterface{}#notes
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
networkConfigurationIResolvable | CfnJobDefinition.NetworkConfigurationPropertynetwork_configurationtyping.Union[IResolvable, NetworkConfigurationProperty]networkConfigurationIResolvableNetworkConfigurationIResolvableNetworkConfigurationinterface{}#Jobs that are running on Amazon EC2 resources must not specify this parameter.
privilegedboolean | IResolvableprivilegedtyping.Union[bool, IResolvable]privilegedBooleanPrivilegedboolPrivilegedinterface{}#notes
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.
readonlyRootFilesystemboolean | IResolvablereadonly_root_filesystemtyping.Union[bool, IResolvable]readonlyRootFilesystemBooleanReadonlyRootFilesystemboolReadonlyRootFilesysteminterface{}#notes
This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
repositoryCredentialsIResolvable | CfnJobDefinition.RepositoryCredentialsPropertyrepository_credentialstyping.Union[IResolvable, RepositoryCredentialsProperty]repositoryCredentialsIResolvableRepositoryCredentialsIResolvableRepositoryCredentialsinterface{}#resourceRequirementsIResolvable | IResolvable | CfnJobDefinition.ResourceRequirementProperty[]resource_requirementstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourceRequirementProperty]]]resourceRequirementsIResolvableResourceRequirementsIResolvableResourceRequirementsinterface{}#The supported resources include GPU , MEMORY , and VCPU .
runtimePlatformIResolvable | CfnJobDefinition.RuntimePlatformPropertyruntime_platformtyping.Union[IResolvable, RuntimePlatformProperty]runtimePlatformIResolvableRuntimePlatformIResolvableRuntimePlatforminterface{}#secretsIResolvable | IResolvable | CfnJobDefinition.SecretProperty[]secretstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SecretProperty]]]secretsIResolvableSecretsIResolvableSecretsinterface{}#For more information, see Specifying sensitive data in the AWS Batch User Guide .
ulimitsIResolvable | IResolvable | CfnJobDefinition.UlimitProperty[]ulimitstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, UlimitProperty]]]ulimitsIResolvableUlimitsIResolvableUlimitsinterface{}#notes
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.
notes
This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
notes
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 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.
volumesIResolvable | IResolvable | CfnJobDefinition.VolumesProperty[]volumestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VolumesProperty]]]volumesIResolvableVolumesIResolvableVolumesinterface{}#