ContainerProperties (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.ContainerProperties

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ContainerProperties
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Container properties are used in job definitions to describe the container that is launched as part of a job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContainerProperties()

Constructors
Constructor and Description
`ContainerProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContainerProperties`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCommand()` The command that is passed to the container.
`List<KeyValuePair>`	`getEnvironment()` The environment variables to pass to a container.
`String`	`getImage()` The image used to start a container.
`String`	`getInstanceType()` The instance type to use for a multi-node parallel job.
`String`	`getJobRoleArn()` The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
`LinuxParameters`	`getLinuxParameters()` Linux-specific modifications that are applied to the container, such as details for device mappings.
`Integer`	`getMemory()` The hard limit (in MiB) of memory to present to the container.
`List<MountPoint>`	`getMountPoints()` The mount points for data volumes in your container.
`Boolean`	`getPrivileged()` When this parameter is true, the container is given elevated privileges on the host container instance (similar to the `root` user).
`Boolean`	`getReadonlyRootFilesystem()` When this parameter is true, the container is given read-only access to its root file system.
`List<ResourceRequirement>`	`getResourceRequirements()` The type and amount of a resource to assign to a container.
`List<Ulimit>`	`getUlimits()` A list of `ulimits` to set in the container.
`String`	`getUser()` The user name to use inside the container.
`Integer`	`getVcpus()` The number of vCPUs reserved for the container.
`List<Volume>`	`getVolumes()` A list of data volumes used in a job.
`int`	`hashCode()`
`Boolean`	`isPrivileged()` When this parameter is true, the container is given elevated privileges on the host container instance (similar to the `root` user).
`Boolean`	`isReadonlyRootFilesystem()` When this parameter is true, the container is given read-only access to its root file system.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCommand(Collection<String> command)` The command that is passed to the container.
`void`	`setEnvironment(Collection<KeyValuePair> environment)` The environment variables to pass to a container.
`void`	`setImage(String image)` The image used to start a container.
`void`	`setInstanceType(String instanceType)` The instance type to use for a multi-node parallel job.
`void`	`setJobRoleArn(String jobRoleArn)` The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
`void`	`setLinuxParameters(LinuxParameters linuxParameters)` Linux-specific modifications that are applied to the container, such as details for device mappings.
`void`	`setMemory(Integer memory)` The hard limit (in MiB) of memory to present to the container.
`void`	`setMountPoints(Collection<MountPoint> mountPoints)` The mount points for data volumes in your container.
`void`	`setPrivileged(Boolean privileged)` When this parameter is true, the container is given elevated privileges on the host container instance (similar to the `root` user).
`void`	`setReadonlyRootFilesystem(Boolean readonlyRootFilesystem)` When this parameter is true, the container is given read-only access to its root file system.
`void`	`setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)` The type and amount of a resource to assign to a container.
`void`	`setUlimits(Collection<Ulimit> ulimits)` A list of `ulimits` to set in the container.
`void`	`setUser(String user)` The user name to use inside the container.
`void`	`setVcpus(Integer vcpus)` The number of vCPUs reserved for the container.
`void`	`setVolumes(Collection<Volume> volumes)` A list of data volumes used in a job.
`String`	`toString()` Returns a string representation of this object.
`ContainerProperties`	`withCommand(Collection<String> command)` The command that is passed to the container.
`ContainerProperties`	`withCommand(String... command)` The command that is passed to the container.
`ContainerProperties`	`withEnvironment(Collection<KeyValuePair> environment)` The environment variables to pass to a container.
`ContainerProperties`	`withEnvironment(KeyValuePair... environment)` The environment variables to pass to a container.
`ContainerProperties`	`withImage(String image)` The image used to start a container.
`ContainerProperties`	`withInstanceType(String instanceType)` The instance type to use for a multi-node parallel job.
`ContainerProperties`	`withJobRoleArn(String jobRoleArn)` The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
`ContainerProperties`	`withLinuxParameters(LinuxParameters linuxParameters)` Linux-specific modifications that are applied to the container, such as details for device mappings.
`ContainerProperties`	`withMemory(Integer memory)` The hard limit (in MiB) of memory to present to the container.
`ContainerProperties`	`withMountPoints(Collection<MountPoint> mountPoints)` The mount points for data volumes in your container.
`ContainerProperties`	`withMountPoints(MountPoint... mountPoints)` The mount points for data volumes in your container.
`ContainerProperties`	`withPrivileged(Boolean privileged)` When this parameter is true, the container is given elevated privileges on the host container instance (similar to the `root` user).
`ContainerProperties`	`withReadonlyRootFilesystem(Boolean readonlyRootFilesystem)` When this parameter is true, the container is given read-only access to its root file system.
`ContainerProperties`	`withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)` The type and amount of a resource to assign to a container.
`ContainerProperties`	`withResourceRequirements(ResourceRequirement... resourceRequirements)` The type and amount of a resource to assign to a container.
`ContainerProperties`	`withUlimits(Collection<Ulimit> ulimits)` A list of `ulimits` to set in the container.
`ContainerProperties`	`withUlimits(Ulimit... ulimits)` A list of `ulimits` to set in the container.
`ContainerProperties`	`withUser(String user)` The user name to use inside the container.
`ContainerProperties`	`withVcpus(Integer vcpus)` The number of vCPUs reserved for the container.
`ContainerProperties`	`withVolumes(Collection<Volume> volumes)` A list of data volumes used in a job.
`ContainerProperties`	`withVolumes(Volume... volumes)` A list of data volumes used in a job.

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

- Constructor Detail
  - ContainerProperties
```
public ContainerProperties()
```
- Method Detail
  - setImage
```
public void setImage(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.
    - 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).
    Parameters:
    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.
    
    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).
  - getImage
```
public String getImage()
```
    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.
    - 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.
    
    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).
  - withImage
```
public ContainerProperties withImage(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.
    - 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).
    Parameters:
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVcpus
```
public void setVcpus(Integer vcpus)
```
    The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
    
    Parameters:
    
    vcpus - The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
  - getVcpus
```
public Integer getVcpus()
```
    The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
    
    Returns:
    
    The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
  - withVcpus
```
public ContainerProperties withVcpus(Integer vcpus)
```
    The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
    
    Parameters:
    
    vcpus - The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMemory
```
public void setMemory(Integer memory)
```
    The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
    
    If you are 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.
    
    Parameters:
    
    memory - The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
    
    If you are 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.
  - getMemory
```
public Integer getMemory()
```
    The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
    
    If you are 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:
    
    The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
    
    If you are 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.
  - withMemory
```
public ContainerProperties withMemory(Integer memory)
```
    The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
    
    If you are 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.
    
    Parameters:
    
    memory - The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
    
    If you are 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCommand
```
public List<String> getCommand()
```
    The command that is 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.
    
    Returns:
    
    The command that is 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.
  - setCommand
```
public void setCommand(Collection<String> command)
```
    The command that is 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.
    
    Parameters:
    
    command - The command that is 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.
  - withCommand
```
public ContainerProperties withCommand(String... command)
```
    The command that is 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCommand(java.util.Collection) or withCommand(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    command - The command that is 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCommand
```
public ContainerProperties withCommand(Collection<String> command)
```
    The command that is 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.
    
    Parameters:
    
    command - The command that is 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobRoleArn
```
public void setJobRoleArn(String jobRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
    
    Parameters:
    
    jobRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
  - getJobRoleArn
```
public String getJobRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
  - withJobRoleArn
```
public ContainerProperties withJobRoleArn(String jobRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
    
    Parameters:
    
    jobRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVolumes
```
public List<Volume> getVolumes()
```
    A list of data volumes used in a job.
    
    Returns:
    
    A list of data volumes used in a job.
  - setVolumes
```
public void setVolumes(Collection<Volume> volumes)
```
    A list of data volumes used in a job.
    
    Parameters:
    
    volumes - A list of data volumes used in a job.
  - withVolumes
```
public ContainerProperties withVolumes(Volume... volumes)
```
    A list of data volumes used in a job.
    
    NOTE: This method appends the values to the existing list (if any). Use setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    volumes - A list of data volumes used in a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVolumes
```
public ContainerProperties withVolumes(Collection<Volume> volumes)
```
    A list of data volumes used in a job.
    
    Parameters:
    
    volumes - A list of data volumes used in a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironment
```
public List<KeyValuePair> getEnvironment()
```
    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 do not 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.
    
    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 do not 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.
  - setEnvironment
```
public void setEnvironment(Collection<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 do not 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.
    
    Parameters:
    
    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 do not 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.
  - withEnvironment
```
public ContainerProperties withEnvironment(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 do not 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setEnvironment(java.util.Collection) or withEnvironment(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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 do not 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnvironment
```
public ContainerProperties withEnvironment(Collection<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 do not 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.
    
    Parameters:
    
    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 do not 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMountPoints
```
public List<MountPoint> getMountPoints()
```
    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:
    
    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.
  - setMountPoints
```
public void setMountPoints(Collection<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.
    
    Parameters:
    
    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.
  - withMountPoints
```
public ContainerProperties withMountPoints(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setMountPoints(java.util.Collection) or withMountPoints(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMountPoints
```
public ContainerProperties withMountPoints(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadonlyRootFilesystem
```
public void setReadonlyRootFilesystem(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.
    
    Parameters:
    
    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.
  - getReadonlyRootFilesystem
```
public Boolean getReadonlyRootFilesystem()
```
    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.
  - withReadonlyRootFilesystem
```
public ContainerProperties withReadonlyRootFilesystem(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadonlyRootFilesystem
```
public Boolean isReadonlyRootFilesystem()
```
    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.
  - setPrivileged
```
public void setPrivileged(Boolean privileged)
```
    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.
    
    Parameters:
    
    privileged - 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.
  - getPrivileged
```
public Boolean getPrivileged()
```
    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.
    
    Returns:
    
    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.
  - withPrivileged
```
public ContainerProperties withPrivileged(Boolean privileged)
```
    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.
    
    Parameters:
    
    privileged - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPrivileged
```
public Boolean isPrivileged()
```
    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.
    
    Returns:
    
    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.
  - getUlimits
```
public List<Ulimit> getUlimits()
```
    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.
    
    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.
  - setUlimits
```
public void setUlimits(Collection<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.
    
    Parameters:
    
    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.
  - withUlimits
```
public ContainerProperties withUlimits(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setUlimits(java.util.Collection) or withUlimits(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUlimits
```
public ContainerProperties withUlimits(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUser
```
public void setUser(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.
    
    Parameters:
    
    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.
  - getUser
```
public String getUser()
```
    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.
  - withUser
```
public ContainerProperties withUser(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
    
    Parameters:
    
    instanceType - The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
  - getInstanceType
```
public String getInstanceType()
```
    The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
    
    Returns:
    
    The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
  - withInstanceType
```
public ContainerProperties withInstanceType(String instanceType)
```
    The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
    
    Parameters:
    
    instanceType - The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceRequirements
```
public List<ResourceRequirement> getResourceRequirements()
```
    The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    
    Returns:
    
    The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
  - setResourceRequirements
```
public void setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
```
    The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    
    Parameters:
    
    resourceRequirements - The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
  - withResourceRequirements
```
public ContainerProperties withResourceRequirements(ResourceRequirement... resourceRequirements)
```
    The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceRequirements(java.util.Collection) or withResourceRequirements(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceRequirements - The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceRequirements
```
public ContainerProperties withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
```
    The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    
    Parameters:
    
    resourceRequirements - The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLinuxParameters
```
public void setLinuxParameters(LinuxParameters linuxParameters)
```
    Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Parameters:
    
    linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.
  - getLinuxParameters
```
public LinuxParameters getLinuxParameters()
```
    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.
  - withLinuxParameters
```
public ContainerProperties withLinuxParameters(LinuxParameters linuxParameters)
```
    Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Parameters:
    
    linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ContainerProperties clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ContainerProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerProperties

Method Detail

setImage

getImage

withImage

setVcpus

getVcpus

withVcpus

setMemory

getMemory

withMemory

getCommand

setCommand

withCommand

withCommand

setJobRoleArn

getJobRoleArn

withJobRoleArn

getVolumes

setVolumes

withVolumes

withVolumes

getEnvironment

setEnvironment

withEnvironment

withEnvironment

getMountPoints

setMountPoints

withMountPoints

withMountPoints

setReadonlyRootFilesystem

getReadonlyRootFilesystem

withReadonlyRootFilesystem

isReadonlyRootFilesystem

setPrivileged

getPrivileged

withPrivileged

isPrivileged

getUlimits

setUlimits

withUlimits

withUlimits

setUser

getUser

withUser

setInstanceType

getInstanceType

withInstanceType

getResourceRequirements

setResourceRequirements

withResourceRequirements

withResourceRequirements

setLinuxParameters

getLinuxParameters

withLinuxParameters

toString

equals

hashCode

clone

marshall