Package software.amazon.awscdk.services.batch

Interface IEcsEc2ContainerDefinition.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEcsContainerDefinition, IEcsContainerDefinition.Jsii$Default, IEcsEc2ContainerDefinition, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IEcsEc2ContainerDefinition.Jsii$Proxy

Enclosing interface:

IEcsEc2ContainerDefinition

@Internal
public static interface IEcsEc2ContainerDefinition.Jsii$Default
extends IEcsEc2ContainerDefinition, IEcsContainerDefinition.Jsii$Default

Internal default implementation for IEcsEc2ContainerDefinition.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IEcsContainerDefinition.Jsii$Default, IEcsContainerDefinition.Jsii$Proxy

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

IEcsEc2ContainerDefinition.Jsii$Default, IEcsEc2ContainerDefinition.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addUlimit(Ulimit ulimit)	Add a ulimit to this container.
default void	addVolume(EcsVolume volume)	Add a Volume to this container.
default List<String>	getCommand()	The command that's passed to the container.
default Number	getCpu()	The number of vCPUs reserved for the container.
default Map<String,String>	getEnvironment()	The environment variables to pass to a container.
default IRole	getExecutionRole()	The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
default Number	getGpu()	The number of physical GPUs to reserve for the container.
default ContainerImage	getImage()	The image that this container will run.
default IRole	getJobRole()	The role that the container can assume.
default LinuxParameters	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as details for device mappings.
default LogDriverConfig	getLogDriverConfig()	The configuration of the log driver.
default Size	getMemory()	The memory hard limit present to the container.
default software.constructs.Node	getNode()	The tree node.
default Boolean	getPrivileged()	When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user).
default Boolean	getReadonlyRootFilesystem()	Gives the container readonly access to its root filesystem.
default Map<String,Secret>	getSecrets()	A map from environment variable names to the secrets for the container.
default List<Ulimit>	getUlimits()	Limits to set for the user this docker container will run as.
default String	getUser()	The user name to use inside the container.
default List<EcsVolume>	getVolumes()	The volumes to mount to this container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IEcsContainerDefinition.Jsii$Default

getCpu

@Stability(Stable)
@NotNull
default Number getCpu()

The number of vCPUs reserved for the container.

Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.

Specified by:

getCpu in interface IEcsContainerDefinition

Specified by:

getCpu in interface IEcsContainerDefinition.Jsii$Default

getExecutionRole

@Stability(Stable)
@NotNull
default IRole getExecutionRole()

The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

Specified by:

getExecutionRole in interface IEcsContainerDefinition

Specified by:

getExecutionRole in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html

getImage

@Stability(Stable)
@NotNull
default ContainerImage getImage()

The image that this container will run.

Specified by:

getImage in interface IEcsContainerDefinition

Specified by:

getImage in interface IEcsContainerDefinition.Jsii$Default

getMemory

@Stability(Stable)
@NotNull
default Size getMemory()

The memory hard limit present to the container.

If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.

Specified by:

getMemory in interface IEcsContainerDefinition

Specified by:

getMemory in interface IEcsContainerDefinition.Jsii$Default

getVolumes

@Stability(Stable)
@NotNull
default List<EcsVolume> getVolumes()

The volumes to mount to this container.

Automatically added to the job definition.

Default: - no volumes

Specified by:

getVolumes in interface IEcsContainerDefinition

Specified by:

getVolumes in interface IEcsContainerDefinition.Jsii$Default

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

The command that's passed to the container.

Specified by:

getCommand in interface IEcsContainerDefinition

Specified by:

getCommand in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.docker.com/engine/reference/builder/#cmd

getEnvironment

@Stability(Stable)
@Nullable
default Map<String,String> getEnvironment()

The environment variables to pass to a container.

Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Default: - no environment variables

Specified by:

getEnvironment in interface IEcsContainerDefinition

Specified by:

getEnvironment in interface IEcsContainerDefinition.Jsii$Default

getJobRole

@Stability(Stable)
@Nullable
default IRole getJobRole()

The role that the container can assume.

Default: - no jobRole

Specified by:

getJobRole in interface IEcsContainerDefinition

Specified by:

getJobRole in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html

getLinuxParameters

@Stability(Stable)
@Nullable
default LinuxParameters getLinuxParameters()

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

Default: none

Specified by:

getLinuxParameters in interface IEcsContainerDefinition

Specified by:

getLinuxParameters in interface IEcsContainerDefinition.Jsii$Default

getLogDriverConfig

@Stability(Stable)
@Nullable
default LogDriverConfig getLogDriverConfig()

The configuration of the log driver.

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition.Jsii$Default

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
default Boolean getReadonlyRootFilesystem()

Gives the container readonly access to its root filesystem.

Default: false

Specified by:

getReadonlyRootFilesystem in interface IEcsContainerDefinition

Specified by:

getReadonlyRootFilesystem in interface IEcsContainerDefinition.Jsii$Default

getSecrets

@Stability(Stable)
@Nullable
default Map<String,Secret> getSecrets()

A map from environment variable names to the secrets for the container.

Allows your job definitions to reference the secret by the environment variable name defined in this property.

Default: - no secrets

Specified by:

getSecrets in interface IEcsContainerDefinition

Specified by:

getSecrets in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html

getUser

@Stability(Stable)
@Nullable
default String getUser()

The user name to use inside the container.

Default: - no user

Specified by:

getUser in interface IEcsContainerDefinition

Specified by:

getUser in interface IEcsContainerDefinition.Jsii$Default

getUlimits

@Stability(Stable)
@NotNull
default List<Ulimit> getUlimits()

Limits to set for the user this docker container will run as.

Specified by:

getUlimits in interface IEcsEc2ContainerDefinition

getGpu

@Stability(Stable)
@Nullable
default Number getGpu()

The number of physical GPUs to reserve for the container.

Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

Default: - no gpus

Specified by:

getGpu in interface IEcsEc2ContainerDefinition

getPrivileged

@Stability(Stable)
@Nullable
default Boolean getPrivileged()

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

Default: false

Specified by:

getPrivileged in interface IEcsEc2ContainerDefinition

addVolume

@Stability(Stable)
default void addVolume(@NotNull
 EcsVolume volume)

Add a Volume to this container.

Specified by:

addVolume in interface IEcsContainerDefinition

Specified by:

addVolume in interface IEcsContainerDefinition.Jsii$Default

Parameters:

volume - This parameter is required.

addUlimit

@Stability(Stable)
default void addUlimit(@NotNull
 Ulimit ulimit)

Add a ulimit to this container.

Specified by:

addUlimit in interface IEcsEc2ContainerDefinition

Parameters:

ulimit - This parameter is required.