Package software.amazon.awscdk.services.batch

Class EcsEc2ContainerDefinitionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

EcsContainerDefinitionProps, EcsEc2ContainerDefinitionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

EcsEc2ContainerDefinitionProps

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

An implementation for EcsEc2ContainerDefinitionProps

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

EcsEc2ContainerDefinitionProps.Builder, EcsEc2ContainerDefinitionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(EcsEc2ContainerDefinitionProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the EcsEc2ContainerDefinitionProps.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 List<String>	getCommand()	The command that's passed to the container.
final Number	getCpu()	The number of vCPUs reserved for the container.
final Boolean	getEnableExecuteCommand()	Determines whether execute command functionality is turned on for this task.
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 LogDriver	getLogging()	The loging configuration for this Job.
final Size	getMemory()	The memory hard limit present to the container.
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.
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(EcsEc2ContainerDefinitionProps.Builder builder)

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

Method Details

getGpu

public final Number getGpu()

Description copied from interface: EcsEc2ContainerDefinitionProps

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 EcsEc2ContainerDefinitionProps

getPrivileged

public final Boolean getPrivileged()

Description copied from interface: EcsEc2ContainerDefinitionProps

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 EcsEc2ContainerDefinitionProps

getUlimits

public final List<Ulimit> getUlimits()

Description copied from interface: EcsEc2ContainerDefinitionProps

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

Default: - no ulimits

Specified by:

getUlimits in interface EcsEc2ContainerDefinitionProps

getCpu

public final Number getCpu()

Description copied from interface: EcsContainerDefinitionProps

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 EcsContainerDefinitionProps

getImage

public final ContainerImage getImage()

Description copied from interface: EcsContainerDefinitionProps

The image that this container will run.

Specified by:

getImage in interface EcsContainerDefinitionProps

getMemory

public final Size getMemory()

Description copied from interface: EcsContainerDefinitionProps

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 EcsContainerDefinitionProps

getCommand

public final List<String> getCommand()

Description copied from interface: EcsContainerDefinitionProps

The command that's passed to the container.

Default: - no command

Specified by:

getCommand in interface EcsContainerDefinitionProps

See Also:

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

getEnableExecuteCommand

public final Boolean getEnableExecuteCommand()

Description copied from interface: EcsContainerDefinitionProps

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.

This allows you to use ECS Exec to access containers interactively. When enabled, a job role with required SSM permissions will be created automatically if no job role is provided. If a job role is alreadyprovided, the required permissions will be added to it.

Default: undefined - AWS Batch default is false

Specified by:

getEnableExecuteCommand in interface EcsContainerDefinitionProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: EcsContainerDefinitionProps

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 EcsContainerDefinitionProps

getExecutionRole

public final IRole getExecutionRole()

Description copied from interface: EcsContainerDefinitionProps

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

Default: - a Role will be created

Specified by:

getExecutionRole in interface EcsContainerDefinitionProps

See Also:

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

getJobRole

public final IRole getJobRole()

Description copied from interface: EcsContainerDefinitionProps

The role that the container can assume.

Default: - no job role

Specified by:

getJobRole in interface EcsContainerDefinitionProps

See Also:

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

getLinuxParameters

public final LinuxParameters getLinuxParameters()

Description copied from interface: EcsContainerDefinitionProps

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

Default: none

Specified by:

getLinuxParameters in interface EcsContainerDefinitionProps

getLogging

public final LogDriver getLogging()

Description copied from interface: EcsContainerDefinitionProps

The loging configuration for this Job.

Default: - the log configuration of the Docker daemon

Specified by:

getLogging in interface EcsContainerDefinitionProps

getReadonlyRootFilesystem

public final Boolean getReadonlyRootFilesystem()

Description copied from interface: EcsContainerDefinitionProps

Gives the container readonly access to its root filesystem.

Default: false

Specified by:

getReadonlyRootFilesystem in interface EcsContainerDefinitionProps

getSecrets

public final Map<String,Secret> getSecrets()

Description copied from interface: EcsContainerDefinitionProps

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 EcsContainerDefinitionProps

See Also:

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

getUser

public final String getUser()

Description copied from interface: EcsContainerDefinitionProps

The user name to use inside the container.

Default: - no user

Specified by:

getUser in interface EcsContainerDefinitionProps

getVolumes

public final List<EcsVolume> getVolumes()

Description copied from interface: EcsContainerDefinitionProps

The volumes to mount to this container.

Automatically added to the job definition.

Default: - no volumes

Specified by:

getVolumes in interface EcsContainerDefinitionProps

$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