Package software.amazon.awscdk.services.batch

Class CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnJobDefinition.ContainerPropertiesProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobDefinition.ContainerPropertiesProperty

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

An implementation for CfnJobDefinition.ContainerPropertiesProperty

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

CfnJobDefinition.ContainerPropertiesProperty.Builder, CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnJobDefinition.ContainerPropertiesProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnJobDefinition.ContainerPropertiesProperty.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	getEnableExecuteCommand()	Determines whether execute command functionality is turned on for this task.
final Object	getEnvironment()	The environment variables to pass to a container.
final Object	getEphemeralStorage()	The amount of ephemeral storage to allocate for the task.
final String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
final Object	getFargatePlatformConfiguration()	The platform configuration for jobs that are running on Fargate resources.
final String	getImage()	Required.
final String	getInstanceType()
final String	getJobRoleArn()	The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
final Object	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as details for device mappings.
final Object	getLogConfiguration()	The log configuration specification for the container.
final Number	getMemory()	This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition.
final Object	getMountPoints()	The mount points for data volumes in your container.
final Object	getNetworkConfiguration()	The network configuration for jobs that are running on Fargate resources.
final Object	getPrivileged()	When this parameter is true, the container is given elevated permissions 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 resources to assign to a container.
final Object	getRuntimePlatform()	An object that represents the compute environment architecture for AWS Batch jobs on Fargate.
final Object	getSecrets()	The secrets for the container.
final Object	getUlimits()	A list of ulimits to set in the container.
final String	getUser()	The user name to use inside the container.
final Number	getVcpus()	This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition.
final Object	getVolumes()	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(CfnJobDefinition.ContainerPropertiesProperty.Builder builder)

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

Method Details

getImage

public final String getImage()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

Required.

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with *repository-url* / *image* : *tag* . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

• Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/ *registry_alias* / *my-web-app* : *latest* .
• Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name> ).
• Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo ).
• Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent ).
• Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu ).

Specified by:

getImage in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getCommand

public final List<String> getCommand()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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 https://docs.docker.com/engine/reference/builder/#cmd .

Specified by:

getCommand in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getEnableExecuteCommand

public final Object getEnableExecuteCommand()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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.

Returns union: either Boolean or IResolvable

Specified by:

getEnableExecuteCommand in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getEnvironment

public final Object getEnvironment()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.EnvironmentProperty>

Specified by:

getEnvironment in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getEphemeralStorage

public final Object getEphemeralStorage()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The amount of ephemeral storage to allocate for the task.

This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .

Returns union: either IResolvable or CfnJobDefinition.EphemeralStorageProperty

Specified by:

getEphemeralStorage in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getExecutionRoleArn

public final String getExecutionRoleArn()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.

For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide .

Specified by:

getExecutionRoleArn in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getFargatePlatformConfiguration

public final Object getFargatePlatformConfiguration()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The platform configuration for jobs that are running on Fargate resources.

Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns union: either IResolvable or CfnJobDefinition.FargatePlatformConfigurationProperty

Specified by:

getFargatePlatformConfiguration in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getInstanceType

public final String getInstanceType()

Specified by:

getInstanceType in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getJobRoleArn

public final String getJobRoleArn()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide .

Specified by:

getJobRoleArn in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getLinuxParameters

public final Object getLinuxParameters()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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

Returns union: either IResolvable or CfnJobDefinition.LinuxParametersProperty

Specified by:

getLinuxParameters in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getLogConfiguration

public final Object getLogConfiguration()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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 might 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 on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

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 | grep "Server API version"

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 .

Returns union: either IResolvable or CfnJobDefinition.LogConfigurationProperty

Specified by:

getLogConfiguration in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getMemory

public final Number getMemory()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition.

It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

Specified by:

getMemory in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getMountPoints

public final Object getMountPoints()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.MountPointsProperty>

Specified by:

getMountPoints in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getNetworkConfiguration

public final Object getNetworkConfiguration()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The network configuration for jobs that are running on Fargate resources.

Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns union: either IResolvable or CfnJobDefinition.NetworkConfigurationProperty

Specified by:

getNetworkConfiguration in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getPrivileged

public final Object getPrivileged()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

When this parameter is true, the container is given elevated permissions 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 . The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

Returns union: either Boolean or IResolvable

Specified by:

getPrivileged in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getReadonlyRootFilesystem

public final Object getReadonlyRootFilesystem()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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 .

Returns union: either Boolean or IResolvable

Specified by:

getReadonlyRootFilesystem in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getRepositoryCredentials

public final Object getRepositoryCredentials()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The private repository authentication credentials to use.

Returns union: either IResolvable or CfnJobDefinition.RepositoryCredentialsProperty

Specified by:

getRepositoryCredentials in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getResourceRequirements

public final Object getResourceRequirements()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

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

The supported resources include GPU , MEMORY , and VCPU .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.ResourceRequirementProperty>

Specified by:

getResourceRequirements in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getRuntimePlatform

public final Object getRuntimePlatform()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Returns union: either IResolvable or CfnJobDefinition.RuntimePlatformProperty

Specified by:

getRuntimePlatform in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getSecrets

public final Object getSecrets()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The secrets for the container.

For more information, see Specifying sensitive data in the AWS Batch User Guide .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.SecretProperty>

Specified by:

getSecrets in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getUlimits

public final Object getUlimits()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

A list of ulimits to set in the container.

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

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.UlimitProperty>

Specified by:

getUlimits in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getUser

public final String getUser()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

The user name 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 .

Specified by:

getUser in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getVcpus

public final Number getVcpus()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition.

It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

Specified by:

getVcpus in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

getVolumes

public final Object getVolumes()

Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty

A list of data volumes used in a job.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobDefinition.VolumesProperty>

Specified by:

getVolumes in interface CfnJobDefinition.ContainerPropertiesProperty

See Also:

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

$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