Package software.amazon.awscdk.services.batch

Class IEcsEc2ContainerDefinition.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

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

Enclosing interface:

IEcsEc2ContainerDefinition

@Internal
public static final class IEcsEc2ContainerDefinition.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IEcsEc2ContainerDefinition.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

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

Constructor Summary

Constructors

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

Method Summary

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

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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

Specified by:

getNode in interface IEcsEc2ContainerDefinition.Jsii$Default

getCpu

@Stability(Stable)
@NotNull
public final 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

Specified by:

getCpu in interface IEcsEc2ContainerDefinition.Jsii$Default

getExecutionRole

@Stability(Stable)
@NotNull
public final 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

Specified by:

getExecutionRole in interface IEcsEc2ContainerDefinition.Jsii$Default

See Also:

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

getImage

@Stability(Stable)
@NotNull
public final ContainerImage getImage()

The image that this container will run.

Specified by:

getImage in interface IEcsContainerDefinition

Specified by:

getImage in interface IEcsContainerDefinition.Jsii$Default

Specified by:

getImage in interface IEcsEc2ContainerDefinition.Jsii$Default

getMemory

@Stability(Stable)
@NotNull
public final 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

Specified by:

getMemory in interface IEcsEc2ContainerDefinition.Jsii$Default

getVolumes

@Stability(Stable)
@NotNull
public final 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

Specified by:

getVolumes in interface IEcsEc2ContainerDefinition.Jsii$Default

getCommand

@Stability(Stable)
@Nullable
public final 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

Specified by:

getCommand in interface IEcsEc2ContainerDefinition.Jsii$Default

See Also:

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

getEnvironment

@Stability(Stable)
@Nullable
public final 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

Specified by:

getEnvironment in interface IEcsEc2ContainerDefinition.Jsii$Default

getJobRole

@Stability(Stable)
@Nullable
public final 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

Specified by:

getJobRole in interface IEcsEc2ContainerDefinition.Jsii$Default

See Also:

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

getLinuxParameters

@Stability(Stable)
@Nullable
public final 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

Specified by:

getLinuxParameters in interface IEcsEc2ContainerDefinition.Jsii$Default

getLogDriverConfig

@Stability(Stable)
@Nullable
public final LogDriverConfig getLogDriverConfig()

The configuration of the log driver.

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition.Jsii$Default

Specified by:

getLogDriverConfig in interface IEcsEc2ContainerDefinition.Jsii$Default

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
public final 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

Specified by:

getReadonlyRootFilesystem in interface IEcsEc2ContainerDefinition.Jsii$Default

getSecrets

@Stability(Stable)
@Nullable
public final 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

Specified by:

getSecrets in interface IEcsEc2ContainerDefinition.Jsii$Default

See Also:

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

getUser

@Stability(Stable)
@Nullable
public final 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

Specified by:

getUser in interface IEcsEc2ContainerDefinition.Jsii$Default

getUlimits

@Stability(Stable)
@NotNull
public final List<Ulimit> getUlimits()

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

Specified by:

getUlimits in interface IEcsEc2ContainerDefinition

Specified by:

getUlimits in interface IEcsEc2ContainerDefinition.Jsii$Default

getGpu

@Stability(Stable)
@Nullable
public final 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

Specified by:

getGpu in interface IEcsEc2ContainerDefinition.Jsii$Default

getPrivileged

@Stability(Stable)
@Nullable
public final 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

Specified by:

getPrivileged in interface IEcsEc2ContainerDefinition.Jsii$Default

addVolume

@Stability(Stable)
public final 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

Specified by:

addVolume in interface IEcsEc2ContainerDefinition.Jsii$Default

Parameters:

volume - This parameter is required.

addUlimit

@Stability(Stable)
public final void addUlimit(@NotNull
 Ulimit ulimit)

Add a ulimit to this container.

Specified by:

addUlimit in interface IEcsEc2ContainerDefinition

Specified by:

addUlimit in interface IEcsEc2ContainerDefinition.Jsii$Default

Parameters:

ulimit - This parameter is required.