Package software.amazon.awscdk.services.batch

Class JobDefinitionContainer.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.JobDefinitionContainer.Jsii$Proxy

All Implemented Interfaces:

JobDefinitionContainer, software.amazon.jsii.JsiiSerializable

Enclosing interface:

JobDefinitionContainer

@Stability(Experimental)
@Internal
public static final class JobDefinitionContainer.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements JobDefinitionContainer

An implementation for JobDefinitionContainer

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.JobDefinitionContainer

JobDefinitionContainer.Builder, JobDefinitionContainer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(JobDefinitionContainer.Builder builder)	Constructor that initializes the object based on literal property values passed by the JobDefinitionContainer.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(JobDefinitionContainer.Builder builder)

Constructor that initializes the object based on literal property values passed by the JobDefinitionContainer.Builder.

Method Details

getImage

public final ContainerImage getImage()

Description copied from interface: JobDefinitionContainer

(experimental) The image used to start a container.

Specified by:

getImage in interface JobDefinitionContainer

getAssignPublicIp

public final Boolean getAssignPublicIp()

Description copied from interface: JobDefinitionContainer

(experimental) Whether or not to assign a public IP to the job.

Default: - false

Specified by:

getAssignPublicIp in interface JobDefinitionContainer

getCommand

public final List<String> getCommand()

Description copied from interface: JobDefinitionContainer

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

Specified by:

getCommand in interface JobDefinitionContainer

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: JobDefinitionContainer

(experimental) The environment variables to pass to the container.

Default: none

Specified by:

getEnvironment in interface JobDefinitionContainer

getExecutionRole

public final IRole getExecutionRole()

Description copied from interface: JobDefinitionContainer

(experimental) The IAM role that AWS Batch can assume.

Required when using Fargate.

Default: - None

Specified by:

getExecutionRole in interface JobDefinitionContainer

getGpuCount

public final Number getGpuCount()

Description copied from interface: JobDefinitionContainer

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

Specified by:

getGpuCount in interface JobDefinitionContainer

getInstanceType

public final InstanceType getInstanceType()

Description copied from interface: JobDefinitionContainer

(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

Specified by:

getInstanceType in interface JobDefinitionContainer

getJobRole

public final IRole getJobRole()

Description copied from interface: JobDefinitionContainer

(experimental) The IAM role that the container can assume for AWS permissions.

Default: - An IAM role will created.

Specified by:

getJobRole in interface JobDefinitionContainer

getLinuxParams

public final LinuxParameters getLinuxParams()

Description copied from interface: JobDefinitionContainer

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

Specified by:

getLinuxParams in interface JobDefinitionContainer

getLogConfiguration

public final LogConfiguration getLogConfiguration()

Description copied from interface: JobDefinitionContainer

(experimental) The log configuration specification for the container.

Default: - containers use the same logging driver that the Docker daemon uses

Specified by:

getLogConfiguration in interface JobDefinitionContainer

getMemoryLimitMiB

public final Number getMemoryLimitMiB()

Description copied from interface: JobDefinitionContainer

(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

Specified by:

getMemoryLimitMiB in interface JobDefinitionContainer

getMountPoints

public final List<MountPoint> getMountPoints()

Description copied from interface: JobDefinitionContainer

(experimental) The mount points for data volumes in your container.

Default: - No mount points will be used.

Specified by:

getMountPoints in interface JobDefinitionContainer

getPlatformVersion

public final FargatePlatformVersion getPlatformVersion()

Description copied from interface: JobDefinitionContainer

(experimental) Fargate platform version.

Default: - LATEST platform version will be used

Specified by:

getPlatformVersion in interface JobDefinitionContainer

getPrivileged

public final Boolean getPrivileged()

Description copied from interface: JobDefinitionContainer

(experimental) When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

Default: false

Specified by:

getPrivileged in interface JobDefinitionContainer

getReadOnly

public final Boolean getReadOnly()

Description copied from interface: JobDefinitionContainer

(experimental) When this parameter is true, the container is given read-only access to its root file system.

Default: false

Specified by:

getReadOnly in interface JobDefinitionContainer

getUlimits

public final List<Ulimit> getUlimits()

Description copied from interface: JobDefinitionContainer

(experimental) A list of ulimits to set in the container.

Default: - No limits.

Specified by:

getUlimits in interface JobDefinitionContainer

getUser

public final String getUser()

Description copied from interface: JobDefinitionContainer

(experimental) The user name to use inside the container.

Default: - None will be used.

Specified by:

getUser in interface JobDefinitionContainer

getVcpus

public final Number getVcpus()

Description copied from interface: JobDefinitionContainer

(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

Specified by:

getVcpus in interface JobDefinitionContainer

getVolumes

public final List<Volume> getVolumes()

Description copied from interface: JobDefinitionContainer

(experimental) A list of data volumes used in a job.

Default: - No data volumes will be used.

Specified by:

getVolumes in interface JobDefinitionContainer

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object