Package software.amazon.awscdk.services.batch

Class CfnJobDefinition.TaskContainerPropertiesProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.CfnJobDefinition.TaskContainerPropertiesProperty.Jsii$Proxy

All Implemented Interfaces:

CfnJobDefinition.TaskContainerPropertiesProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobDefinition.TaskContainerPropertiesProperty

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

An implementation for CfnJobDefinition.TaskContainerPropertiesProperty

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

CfnJobDefinition.TaskContainerPropertiesProperty.Builder, CfnJobDefinition.TaskContainerPropertiesProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnJobDefinition.TaskContainerPropertiesProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnJobDefinition.TaskContainerPropertiesProperty.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 Object	getDependsOn()	A list of containers that this container depends on.
final Object	getEnvironment()	The environment variables to pass to a container.
final Object	getEssential()	If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped.
final Object	getFirelensConfiguration()	The FireLens configuration for the container.
final String	getImage()	The image used to start a container.
final Object	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
final Object	getLogConfiguration()	The log configuration specification for the container.
final Object	getMountPoints()	The mount points for data volumes in your container.
final String	getName()	The name of a container.
final Object	getPrivileged()	When this parameter is true , the container is given elevated privileges on the host container instance (similar to the root user).
final Object	getReadonlyRootFilesystem()	When this parameter is true, the container is given read-only access to its root file system.
final Object	getRepositoryCredentials()	The private repository authentication credentials to use.
final Object	getResourceRequirements()	The type and amount of a resource to assign to a container.
final Object	getSecrets()	The secrets to pass to the container.
final Object	getUlimits()	A list of ulimits to set in the container.
final String	getUser()	The user to use inside the 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(CfnJobDefinition.TaskContainerPropertiesProperty.Builder builder)

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

Method Details

getImage

public final String getImage()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The image used to start a container.

This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .

Specified by:

getImage in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-image

getCommand

public final List<String> getCommand()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The command that's passed to the container.

This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see Dockerfile reference: CMD .

Specified by:

getCommand in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-command

getDependsOn

public final Object getDependsOn()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

A list of containers that this container depends on.

Specified by:

getDependsOn in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-dependson

getEnvironment

public final Object getEnvironment()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The environment variables to pass to a container.

This parameter maps to Env in the Create a container section of the Docker Remote API and the --env parameter to docker run .

We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables cannot start with AWS_BATCH . This naming convention is reserved for variables that AWS Batch sets.

Specified by:

getEnvironment in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-environment

getEssential

public final Object getEssential()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped.

If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .

Specified by:

getEssential in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-essential

getFirelensConfiguration

public final Object getFirelensConfiguration()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The FireLens configuration for the container.

This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide .

Specified by:

getFirelensConfiguration in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-firelensconfiguration

getLinuxParameters

public final Object getLinuxParameters()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

For more information, see KernelCapabilities .

Specified by:

getLinuxParameters in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-linuxparameters

getLogConfiguration

public final Object getLogConfiguration()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation .

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .

Specified by:

getLogConfiguration in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-logconfiguration

getMountPoints

public final Object getMountPoints()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .

Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers can't mount directories on a different drive, and mount point can't be across drives.

Specified by:

getMountPoints in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-mountpoints

getName

public final String getName()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The name of a container.

The name can be used as a unique identifier to target your dependsOn and Overrides objects.

Specified by:

getName in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-name

getPrivileged

public final Object getPrivileged()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

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

This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .

This parameter is not supported for Windows containers or tasks run on Fargate.

Specified by:

getPrivileged in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-privileged

getReadonlyRootFilesystem

public final Object getReadonlyRootFilesystem()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

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

This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .

This parameter is not supported for Windows containers.

Specified by:

getReadonlyRootFilesystem in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-readonlyrootfilesystem

getRepositoryCredentials

public final Object getRepositoryCredentials()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The private repository authentication credentials to use.

Specified by:

getRepositoryCredentials in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-repositorycredentials

getResourceRequirements

public final Object getResourceRequirements()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The type and amount of a resource to assign to a container.

The only supported resource is a GPU.

Specified by:

getResourceRequirements in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-resourcerequirements

getSecrets

public final Object getSecrets()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The secrets to pass to the container.

For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Specified by:

getSecrets in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-secrets

getUlimits

public final Object getUlimits()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

A list of ulimits to set in the container.

If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535 .

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Specified by:

getUlimits in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-ulimits

getUser

public final String getUser()

Description copied from interface: CfnJobDefinition.TaskContainerPropertiesProperty

The user to use inside the container.

This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0) . We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

• user
• user:group
• uid
• uid:gid
• user:gi
• uid:group

This parameter is not supported for Windows containers.

Specified by:

getUser in interface CfnJobDefinition.TaskContainerPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-taskcontainerproperties.html#cfn-batch-jobdefinition-taskcontainerproperties-user

$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