JobDefinitionContainer

All Known Implementing Classes:: JobDefinitionContainer.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:00.646Z")
public interface JobDefinitionContainer

(experimental) Properties of a job definition container.

Example:

 import software.amazon.awscdk.services.ssm.*;
 JobDefinition.Builder.create(this, "job-def")
         .container(JobDefinitionContainer.builder()
                 .image(EcrImage.fromRegistry("docker/whalesay"))
                 .logConfiguration(LogConfiguration.builder()
                         .logDriver(LogDriver.AWSLOGS)
                         .options(Map.of("awslogs-region", "us-east-1"))
                         .secretOptions(List.of(ExposedSecret.fromParametersStore("xyz", StringParameter.fromStringParameterName(this, "parameter", "xyz"))))
                         .build())
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`JobDefinitionContainer.Builder` A builder for `JobDefinitionContainer`
`static class`	`JobDefinitionContainer.Jsii$Proxy` An implementation for `JobDefinitionContainer`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static JobDefinitionContainer.Builder`	`builder()`
`default java.lang.Boolean`	`getAssignPublicIp()` (experimental) Whether or not to assign a public IP to the job.
`default java.util.List<java.lang.String>`	`getCommand()` (experimental) The command that is passed to the container.
`default java.util.Map<java.lang.String,java.lang.String>`	`getEnvironment()` (experimental) The environment variables to pass to the container.
`default IRole`	`getExecutionRole()` (experimental) The IAM role that AWS Batch can assume.
`default java.lang.Number`	`getGpuCount()` (experimental) The number of physical GPUs to reserve for the container.
`ContainerImage`	`getImage()` (experimental) The image used to start a container.
`default InstanceType`	`getInstanceType()` (experimental) The instance type to use for a multi-node parallel job.
`default IRole`	`getJobRole()` (experimental) The IAM role that the container can assume for AWS permissions.
`default LinuxParameters`	`getLinuxParams()` (experimental) Linux-specific modifications that are applied to the container, such as details for device mappings.
`default LogConfiguration`	`getLogConfiguration()` (experimental) The log configuration specification for the container.
`default java.lang.Number`	`getMemoryLimitMiB()` (experimental) The hard limit (in MiB) of memory to present to the container.
`default java.util.List<MountPoint>`	`getMountPoints()` (experimental) The mount points for data volumes in your container.
`default FargatePlatformVersion`	`getPlatformVersion()` (experimental) Fargate platform version.
`default java.lang.Boolean`	`getPrivileged()` (experimental) When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
`default java.lang.Boolean`	`getReadOnly()` (experimental) When this parameter is true, the container is given read-only access to its root file system.
`default java.util.List<Ulimit>`	`getUlimits()` (experimental) A list of ulimits to set in the container.
`default java.lang.String`	`getUser()` (experimental) The user name to use inside the container.
`default java.lang.Number`	`getVcpus()` (experimental) The number of vCPUs reserved for the container.
`default java.util.List<Volume>`	`getVolumes()` (experimental) A list of data volumes used in a job.

- Method Detail
  - getImage
```
ContainerImage getImage()
```
    (experimental) The image used to start a container.
  - getAssignPublicIp
```
default java.lang.Boolean getAssignPublicIp()
```
    (experimental) Whether or not to assign a public IP to the job.
    Default: - false
  - getCommand
```
default java.util.List<java.lang.String> getCommand()
```
    (experimental) The command that is passed to the container.
    If you provide a shell command as a single string, you have to quote command-line arguments.
    Default: - CMD value built into container image.
  - getEnvironment
```
default java.util.Map<java.lang.String,java.lang.String> getEnvironment()
```
    (experimental) The environment variables to pass to the container.
    Default: none
  - getExecutionRole
```
default IRole getExecutionRole()
```
    (experimental) The IAM role that AWS Batch can assume.
    Required when using Fargate.
    Default: - None
  - getGpuCount
```
default java.lang.Number getGpuCount()
```
    (experimental) The number of physical GPUs to reserve for the container.
    The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
    Default: - No GPU reservation.
  - getInstanceType
```
default InstanceType getInstanceType()
```
    (experimental) The instance type to use for a multi-node parallel job.
    Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
    Default: - None
  - getJobRole
```
default IRole getJobRole()
```
    (experimental) The IAM role that the container can assume for AWS permissions.
    Default: - An IAM role will created.
  - getLinuxParams
```
default LinuxParameters getLinuxParams()
```
    (experimental) Linux-specific modifications that are applied to the container, such as details for device mappings.
    For now, only the devices property is supported.
    Default: - None will be used.
  - getLogConfiguration
```
default LogConfiguration getLogConfiguration()
```
    (experimental) The log configuration specification for the container.
    Default: - containers use the same logging driver that the Docker daemon uses
  - getMemoryLimitMiB
```
default java.lang.Number getMemoryLimitMiB()
```
    (experimental) The hard limit (in MiB) of memory to present to the container.
    If your container attempts to exceed the memory specified here, the container is killed. You must specify at least 4 MiB of memory for EC2 and 512 MiB for Fargate.
    Default: - 4 for EC2, 512 for Fargate
  - getMountPoints
```
default java.util.List<MountPoint> getMountPoints()
```
    (experimental) The mount points for data volumes in your container.
    Default: - No mount points will be used.
  - getPlatformVersion
```
default FargatePlatformVersion getPlatformVersion()
```
    (experimental) Fargate platform version.
    Default: - LATEST platform version will be used
  - getPrivileged
```
default java.lang.Boolean getPrivileged()
```
    (experimental) When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
    Default: false
  - getReadOnly
```
default java.lang.Boolean getReadOnly()
```
    (experimental) When this parameter is true, the container is given read-only access to its root file system.
    Default: false
  - getUlimits
```
default java.util.List<Ulimit> getUlimits()
```
    (experimental) A list of ulimits to set in the container.
    Default: - No limits.
  - getUser
```
default java.lang.String getUser()
```
    (experimental) The user name to use inside the container.
    Default: - None will be used.
  - getVcpus
```
default java.lang.Number getVcpus()
```
    (experimental) The number of vCPUs reserved for the container.
    Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU for EC2 and 0.25 for Fargate.
    Default: - 1 for EC2, 0.25 for Fargate
  - getVolumes
```
default java.util.List<Volume> getVolumes()
```
    (experimental) A list of data volumes used in a job.
    Default: - No data volumes will be used.
  - builder
```
static JobDefinitionContainer.Builder builder()
```
    Returns:
    
    a JobDefinitionContainer.Builder of JobDefinitionContainer

Interface JobDefinitionContainer

Nested Class Summary

Method Summary

Method Detail

getImage

getAssignPublicIp

getCommand

getEnvironment

getExecutionRole

getGpuCount

getInstanceType

getJobRole

getLinuxParams

getLogConfiguration

getMemoryLimitMiB

getMountPoints

getPlatformVersion

getPrivileged

getReadOnly

getUlimits

getUser

getVcpus

getVolumes

builder