public static interface ContainerProperties.Builder extends SdkPojo, CopyableBuilder<ContainerProperties.Builder,ContainerProperties>
| Modifier and Type | Method and Description |
|---|---|
ContainerProperties.Builder |
command(Collection<String> command)
The command that is passed to the container.
|
ContainerProperties.Builder |
command(String... command)
The command that is passed to the container.
|
ContainerProperties.Builder |
environment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
|
ContainerProperties.Builder |
environment(Consumer<KeyValuePair.Builder>... environment)
The environment variables to pass to a container.
|
ContainerProperties.Builder |
environment(KeyValuePair... environment)
The environment variables to pass to a container.
|
ContainerProperties.Builder |
executionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
ContainerProperties.Builder |
image(String image)
The image used to start a container.
|
ContainerProperties.Builder |
instanceType(String instanceType)
The instance type to use for a multi-node parallel job.
|
ContainerProperties.Builder |
jobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
|
default ContainerProperties.Builder |
linuxParameters(Consumer<LinuxParameters.Builder> linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
ContainerProperties.Builder |
linuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
default ContainerProperties.Builder |
logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration)
The log configuration specification for the container.
|
ContainerProperties.Builder |
logConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
ContainerProperties.Builder |
memory(Integer memory)
The hard limit (in MiB) of memory to present to the container.
|
ContainerProperties.Builder |
mountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
|
ContainerProperties.Builder |
mountPoints(Consumer<MountPoint.Builder>... mountPoints)
The mount points for data volumes in your container.
|
ContainerProperties.Builder |
mountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
|
ContainerProperties.Builder |
privileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance
(similar to the
root user). |
ContainerProperties.Builder |
readonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system.
|
ContainerProperties.Builder |
resourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerProperties.Builder |
resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerProperties.Builder |
resourceRequirements(ResourceRequirement... resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerProperties.Builder |
secrets(Collection<Secret> secrets)
The secrets for the container.
|
ContainerProperties.Builder |
secrets(Consumer<Secret.Builder>... secrets)
The secrets for the container.
|
ContainerProperties.Builder |
secrets(Secret... secrets)
The secrets for the container.
|
ContainerProperties.Builder |
ulimits(Collection<Ulimit> ulimits)
A list of
ulimits to set in the container. |
ContainerProperties.Builder |
ulimits(Consumer<Ulimit.Builder>... ulimits)
A list of
ulimits to set in the container. |
ContainerProperties.Builder |
ulimits(Ulimit... ulimits)
A list of
ulimits to set in the container. |
ContainerProperties.Builder |
user(String user)
The user name to use inside the container.
|
ContainerProperties.Builder |
vcpus(Integer vcpus)
The number of vCPUs reserved for the container.
|
ContainerProperties.Builder |
volumes(Collection<Volume> volumes)
A list of data volumes used in a job.
|
ContainerProperties.Builder |
volumes(Consumer<Volume.Builder>... volumes)
A list of data volumes used in a job.
|
ContainerProperties.Builder |
volumes(Volume... volumes)
A list of data volumes used in a job.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildContainerProperties.Builder image(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).
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).
ContainerProperties.Builder vcpus(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. This is required but can be specified in several places
for multi-node parallel (MNP) jobs; it must be specified for each node at least once.
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. This is
required but can be specified in several places for multi-node parallel (MNP) jobs; it must be
specified for each node at least once.ContainerProperties.Builder memory(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. This is required but can be specified in several places for multi-node parallel (MNP) jobs;
it must be specified for each node at least once.
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.
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. This is required but can be specified in
several places for multi-node parallel (MNP) jobs; it must be specified for each node at least
once. 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.
ContainerProperties.Builder command(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.
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.ContainerProperties.Builder command(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.
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.ContainerProperties.Builder jobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
jobRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.ContainerProperties.Builder executionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.
executionRoleArn - The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information,
see AWS Batch
execution IAM role.ContainerProperties.Builder volumes(Collection<Volume> volumes)
A list of data volumes used in a job.
volumes - A list of data volumes used in a job.ContainerProperties.Builder volumes(Volume... volumes)
A list of data volumes used in a job.
volumes - A list of data volumes used in a job.ContainerProperties.Builder volumes(Consumer<Volume.Builder>... volumes)
A list of data volumes used in a job.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #volumes(List) .volumes - a consumer that will call methods on List.Builder #volumes(List) ContainerProperties.Builder environment(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.
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.
ContainerProperties.Builder environment(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.
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.
ContainerProperties.Builder environment(Consumer<KeyValuePair.Builder>... 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.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #environment(List) .environment - a consumer that will call methods on List.Builder #environment(List) ContainerProperties.Builder mountPoints(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.
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.ContainerProperties.Builder mountPoints(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.
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.ContainerProperties.Builder mountPoints(Consumer<MountPoint.Builder>... 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.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #mountPoints(List) .mountPoints - a consumer that will call methods on List.Builder #mountPoints(List) ContainerProperties.Builder readonlyRootFilesystem(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.
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.ContainerProperties.Builder privileged(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.
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.ContainerProperties.Builder ulimits(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.
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.ContainerProperties.Builder ulimits(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.
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.ContainerProperties.Builder ulimits(Consumer<Ulimit.Builder>... 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.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #ulimits(List) .ulimits - a consumer that will call methods on List.Builder #ulimits(List) ContainerProperties.Builder user(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.
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.ContainerProperties.Builder instanceType(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.
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.ContainerProperties.Builder resourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.
resourceRequirements - The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.ContainerProperties.Builder resourceRequirements(ResourceRequirement... resourceRequirements)
The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.
resourceRequirements - The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.ContainerProperties.Builder resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements)
The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #resourceRequirements(List) .resourceRequirements - a consumer that will call methods on List.Builder #resourceRequirements(List) ContainerProperties.Builder linuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.default ContainerProperties.Builder linuxParameters(Consumer<LinuxParameters.Builder> linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
This is a convenience that creates an instance of theLinuxParameters.Builder avoiding the need to
create one manually via LinuxParameters.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to linuxParameters(LinuxParameters).linuxParameters - a consumer that will call methods on LinuxParameters.BuilderlinuxParameters(LinuxParameters)ContainerProperties.Builder logConfiguration(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 may 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.
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 may 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.
default ContainerProperties.Builder logConfiguration(Consumer<LogConfiguration.Builder> 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 may 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.
LogConfiguration.Builder avoiding the
need to create one manually via LogConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to logConfiguration(LogConfiguration).logConfiguration - a consumer that will call methods on LogConfiguration.BuilderlogConfiguration(LogConfiguration)ContainerProperties.Builder secrets(Collection<Secret> secrets)
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
secrets - The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.ContainerProperties.Builder secrets(Secret... secrets)
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
secrets - The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.ContainerProperties.Builder secrets(Consumer<Secret.Builder>... secrets)
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #secrets(List) .secrets - a consumer that will call methods on List.Builder #secrets(List) Copyright © 2020. All rights reserved.