ContainerProperties (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.batch.model.ContainerProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerProperties.Builder,ContainerProperties>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ContainerProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerProperties.Builder,ContainerProperties>
```
Container properties are used in job definitions to describe the container that's launched as part of a job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ContainerProperties.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ContainerProperties.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ContainerProperties.Builder`	`builder()`
`List<String>`	`command()` The command that's passed to the container.
`List<KeyValuePair>`	`environment()` The environment variables to pass to a container.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()` The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
`FargatePlatformConfiguration`	`fargatePlatformConfiguration()` The platform configuration for jobs running on Fargate resources.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCommand()` Returns true if the Command property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnvironment()` Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasMountPoints()` Returns true if the MountPoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasResourceRequirements()` Returns true if the ResourceRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSecrets()` Returns true if the Secrets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUlimits()` Returns true if the Ulimits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasVolumes()` Returns true if the Volumes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`image()` The image used to start a container.
`String`	`instanceType()` The instance type to use for a multi-node parallel job.
`String`	`jobRoleArn()` The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
`LinuxParameters`	`linuxParameters()` Linux-specific modifications that are applied to the container, such as details for device mappings.
`LogConfiguration`	`logConfiguration()` The log configuration specification for the container.
`Integer`	`memory()` This parameter indicates the memory hard limit (in MiB) for a container.
`List<MountPoint>`	`mountPoints()` The mount points for data volumes in your container.
`NetworkConfiguration`	`networkConfiguration()` The network configuration for jobs running on Fargate resources.
`Boolean`	`privileged()` When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user).
`Boolean`	`readonlyRootFilesystem()` When this parameter is true, the container is given read-only access to its root file system.
`List<ResourceRequirement>`	`resourceRequirements()` The type and amount of resources to assign to a container.
`List<SdkField<?>>`	`sdkFields()`
`List<Secret>`	`secrets()` The secrets for the container.
`static Class<? extends ContainerProperties.Builder>`	`serializableBuilderClass()`
`ContainerProperties.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<Ulimit>`	`ulimits()` A list of `ulimits` to set in the container.
`String`	`user()` The user name to use inside the container.
`Integer`	`vcpus()` The number of vCPUs reserved for the job.
`List<Volume>`	`volumes()` A list of data volumes used in a job.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - image
```
public final String image()
```
    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 . 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 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 repositories use the full registry and repository URI (for example, 012345678910.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).
    Returns:
    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 . 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 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 repositories use the full registry and repository URI (for example, 012345678910.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).
  - vcpus
```
public final Integer vcpus()
```
    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 be specified in several places. You must specify it at least once for each node.
    
    This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead. You can use this parameter or resourceRequirements structure but not both.
    
    This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
    
    Returns:
    
    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 be specified in several places. You must specify it at least once for each node.
    
    This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead. You can use this parameter or resourceRequirements structure but not both.
    
    This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
  - memory
```
public final Integer memory()
```
    This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it is 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.
    
    This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
    
    This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you should specify the memory requirement using resourceRequirement. You can do this for EC2 resources.
    
    If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
    
    Returns:
    
    This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it is 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.
    
    This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
    
    This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you should specify the memory requirement using resourceRequirement. You can do this for EC2 resources.
    
    If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
  - hasCommand
```
public final boolean hasCommand()
```
    Returns true if the Command property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - command
```
public final List<String> command()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCommand() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - jobRoleArn
```
public final String jobRoleArn()
```
    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.
    
    Returns:
    
    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.
  - executionRoleArn
```
public final String executionRoleArn()
```
    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.
    
    Returns:
    
    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.
  - hasVolumes
```
public final boolean hasVolumes()
```
    Returns true if the Volumes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - volumes
```
public final List<Volume> volumes()
```
    A list of data volumes used in a job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasVolumes() to see if a value was sent in this field.
    
    Returns:
    
    A list of data volumes used in a job.
  - hasEnvironment
```
public final boolean hasEnvironment()
```
    Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - environment
```
public final List<KeyValuePair> environment()
```
    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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEnvironment() to see if a value was sent in this field.
    
    Returns:
    
    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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
  - hasMountPoints
```
public final boolean hasMountPoints()
```
    Returns true if the MountPoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - mountPoints
```
public final List<MountPoint> mountPoints()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMountPoints() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - readonlyRootFilesystem
```
public final Boolean readonlyRootFilesystem()
```
    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:
    
    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.
  - privileged
```
public final Boolean privileged()
```
    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 running on Fargate resources and shouldn't be provided, or specified as false.
    
    Returns:
    
    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 running on Fargate resources and shouldn't be provided, or specified as false.
  - hasUlimits
```
public final boolean hasUlimits()
```
    Returns true if the Ulimits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - ulimits
```
public final List<Ulimit> ulimits()
```
    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 running on Fargate resources and shouldn't be provided.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUlimits() to see if a value was sent in this field.
    
    Returns:
    
    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 running on Fargate resources and shouldn't be provided.
  - user
```
public final String user()
```
    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.
    
    Returns:
    
    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.
  - instanceType
```
public final String instanceType()
```
    The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
    
    This parameter isn't applicable to single-node container jobs or for jobs that run on Fargate resources and shouldn't be provided.
    
    Returns:
    
    The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
    
    This parameter isn't applicable to single-node container jobs or for jobs that run on Fargate resources and shouldn't be provided.
  - hasResourceRequirements
```
public final boolean hasResourceRequirements()
```
    Returns true if the ResourceRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - resourceRequirements
```
public final List<ResourceRequirement> resourceRequirements()
```
    The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasResourceRequirements() to see if a value was sent in this field.
    
    Returns:
    
    The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
  - linuxParameters
```
public final LinuxParameters linuxParameters()
```
    Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Returns:
    
    Linux-specific modifications that are applied to the container, such as details for device mappings.
  - logConfiguration
```
public final LogConfiguration logConfiguration()
```
    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 into 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:
    
    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 into 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.
  - hasSecrets
```
public final boolean hasSecrets()
```
    Returns true if the Secrets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - secrets
```
public final List<Secret> secrets()
```
    The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecrets() to see if a value was sent in this field.
    
    Returns:
    
    The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
  - networkConfiguration
```
public final NetworkConfiguration networkConfiguration()
```
    The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
    
    Returns:
    
    The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
  - fargatePlatformConfiguration
```
public final FargatePlatformConfiguration fargatePlatformConfiguration()
```
    The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
    
    Returns:
    
    The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
  - toBuilder
```
public ContainerProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ContainerProperties.Builder,ContainerProperties>
  - builder
```
public static ContainerProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ContainerProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ContainerProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

image

vcpus

memory

hasCommand

command

jobRoleArn

executionRoleArn

hasVolumes

volumes

hasEnvironment

environment

hasMountPoints

mountPoints

readonlyRootFilesystem

privileged

hasUlimits

ulimits

user

instanceType

hasResourceRequirements

resourceRequirements

linuxParameters

logConfiguration

hasSecrets

secrets

networkConfiguration

fargatePlatformConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields