public static interface ContainerProperties.Builder extends 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 |
image(String image)
The image used to start a container.
|
ContainerProperties.Builder |
jobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
|
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 |
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.
|
copy
applyMutation, build
ContainerProperties.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 1 vCPU.
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 1 vCPU.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.
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.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 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 plain text 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 plain text 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 plain text 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 plain text 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 plain text 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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.