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"))
.enableExecuteCommand(false)
.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)
.repositoryCredentials(RepositoryCredentialsProperty.builder()
.credentialsParameter("credentialsParameter")
.build())
.resourceRequirements(List.of(ResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.runtimePlatform(RuntimePlatformProperty.builder()
.cpuArchitecture("cpuArchitecture")
.operatingSystemFamily("operatingSystemFamily")
.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnJobDefinition.ContainerPropertiesPropertystatic final classAn implementation forCfnJobDefinition.ContainerPropertiesProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The command that's passed to the container.default ObjectDetermines whether execute command functionality is turned on for this task.default ObjectThe environment variables to pass to a container.default ObjectThe amount of ephemeral storage to allocate for the task.default StringThe Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.default ObjectThe platform configuration for jobs that are running on Fargate resources.getImage()Required.default Stringdefault StringThe Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.default ObjectLinux-specific modifications that are applied to the container, such as details for device mappings.default ObjectThe log configuration specification for the container.default NumberThis parameter is deprecated, useresourceRequirementsto specify the memory requirements for the job definition.default ObjectThe mount points for data volumes in your container.default ObjectThe network configuration for jobs that are running on Fargate resources.default ObjectWhen this parameter is true, the container is given elevated permissions 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 resources to assign to a container.default ObjectAn object that represents the compute environment architecture for AWS Batch jobs on Fargate.default ObjectThe secrets for the container.default ObjectA list ofulimitsto set in the container.default StringgetUser()The user name to use inside the container.default NumbergetVcpus()This parameter is deprecated, useresourceRequirementsto specify the vCPU requirements for the job definition.default ObjectA list of data volumes used in a job.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getImage
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 toImagein the Create a container section of the Docker Remote API and theIMAGEparameter 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).
- See Also:
- Images in Amazon ECR Public repositories use the full
-
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 https://docs.docker.com/engine/reference/builder/#cmd .- See Also:
-
getEnableExecuteCommand
Determines whether execute command functionality is turned on for this task.If
true, execute command functionality is turned on all the containers in the task.Returns union: either
BooleanorIResolvable- See Also:
-
getEnvironment
The environment variables to pass to a container.This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption 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:
-
getEphemeralStorage
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 .
Returns union: either
IResolvableorCfnJobDefinition.EphemeralStorageProperty- See Also:
-
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 .
- See Also:
-
getFargatePlatformConfiguration
The platform configuration for jobs that are running on Fargate resources.Jobs that are running on Amazon EC2 resources must not specify this parameter.
Returns union: either
IResolvableorCfnJobDefinition.FargatePlatformConfigurationProperty- See Also:
-
getInstanceType
- See Also:
-
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 .
- See Also:
-
getLinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.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 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 .Returns union: either
IResolvableorCfnJobDefinition.LogConfigurationProperty- See Also:
-
getMemory
This parameter is deprecated, useresourceRequirementsto 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.
- 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--volumeoption to docker run .Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.MountPointsProperty>- See Also:
-
getNetworkConfiguration
The network configuration for jobs that are running on Fargate resources.Jobs that are running on Amazon EC2 resources must not specify this parameter.
Returns union: either
IResolvableorCfnJobDefinition.NetworkConfigurationProperty- See Also:
-
getPrivileged
When this parameter is true, the container is given elevated permissions 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 . 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.
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 todocker run.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 resources to assign to a container.The supported resources include
GPU,MEMORY, andVCPU.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.ResourceRequirementProperty>- See Also:
-
getRuntimePlatform
An object that represents the compute environment architecture for AWS Batch jobs on Fargate.Returns union: either
IResolvableorCfnJobDefinition.RuntimePlatformProperty- See Also:
-
getSecrets
The secrets for the container.For more information, see Specifying sensitive data in the AWS Batch User Guide .
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.SecretProperty>- See Also:
-
getUlimits
A list ofulimitsto set in the container.This parameter maps to
Ulimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run .This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.UlimitProperty>- See Also:
-
getUser
The user name to use inside the container.This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run .- See Also:
-
getVcpus
This parameter is deprecated, useresourceRequirementsto 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
CpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.- See Also:
-
getVolumes
A list of data volumes used in a job.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobDefinition.VolumesProperty>- See Also:
-
builder
-