public static interface ContainerDetail.Builder extends CopyableBuilder<ContainerDetail.Builder,ContainerDetail>
Modifier and Type | Method and Description |
---|---|
ContainerDetail.Builder |
command(Collection<String> command)
The command that is passed to the container.
|
ContainerDetail.Builder |
command(String... command)
The command that is passed to the container.
|
ContainerDetail.Builder |
containerInstanceArn(String containerInstanceArn)
The Amazon Resource Name (ARN) of the container instance on which the container is running.
|
ContainerDetail.Builder |
environment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
|
ContainerDetail.Builder |
environment(KeyValuePair... environment)
The environment variables to pass to a container.
|
ContainerDetail.Builder |
exitCode(Integer exitCode)
The exit code to return upon completion.
|
ContainerDetail.Builder |
image(String image)
The image used to start the container.
|
ContainerDetail.Builder |
jobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) associated with the job upon execution.
|
ContainerDetail.Builder |
logStreamName(String logStreamName)
The name of the CloudWatch Logs log stream associated with the container.
|
ContainerDetail.Builder |
memory(Integer memory)
The number of MiB of memory reserved for the job.
|
ContainerDetail.Builder |
mountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
|
ContainerDetail.Builder |
mountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
|
ContainerDetail.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). |
ContainerDetail.Builder |
readonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system.
|
ContainerDetail.Builder |
reason(String reason)
A short (255 max characters) human-readable string to provide additional details about a running or stopped
container.
|
ContainerDetail.Builder |
taskArn(String taskArn)
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
|
ContainerDetail.Builder |
ulimits(Collection<Ulimit> ulimits)
A list of
ulimit values to set in the container. |
ContainerDetail.Builder |
ulimits(Ulimit... ulimits)
A list of
ulimit values to set in the container. |
ContainerDetail.Builder |
user(String user)
The user name to use inside the container.
|
ContainerDetail.Builder |
vcpus(Integer vcpus)
The number of VCPUs allocated for the job.
|
ContainerDetail.Builder |
volumes(Collection<Volume> volumes)
A list of volumes associated with the job.
|
ContainerDetail.Builder |
volumes(Volume... volumes)
A list of volumes associated with the job.
|
copy
apply, build
ContainerDetail.Builder image(String image)
The image used to start the container.
image
- The image used to start the container.ContainerDetail.Builder vcpus(Integer vcpus)
The number of VCPUs allocated for the job.
vcpus
- The number of VCPUs allocated for the job.ContainerDetail.Builder memory(Integer memory)
The number of MiB of memory reserved for the job.
memory
- The number of MiB of memory reserved for the job.ContainerDetail.Builder command(Collection<String> command)
The command that is passed to the container.
command
- The command that is passed to the container.ContainerDetail.Builder command(String... command)
The command that is passed to the container.
command
- The command that is passed to the container.ContainerDetail.Builder jobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) associated with the job upon execution.
jobRoleArn
- The Amazon Resource Name (ARN) associated with the job upon execution.ContainerDetail.Builder volumes(Collection<Volume> volumes)
A list of volumes associated with the job.
volumes
- A list of volumes associated with the job.ContainerDetail.Builder volumes(Volume... volumes)
A list of volumes associated with the job.
volumes
- A list of volumes associated with the job.ContainerDetail.Builder environment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
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.
Environment variables must not start with AWS_BATCH
; this naming convention is reserved
for variables that are set by the AWS Batch service.
ContainerDetail.Builder environment(KeyValuePair... environment)
The environment variables to pass to a container.
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.
Environment variables must not start with AWS_BATCH
; this naming convention is reserved
for variables that are set by the AWS Batch service.
ContainerDetail.Builder mountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
mountPoints
- The mount points for data volumes in your container.ContainerDetail.Builder mountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
mountPoints
- The mount points for data volumes in your container.ContainerDetail.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system.
readonlyRootFilesystem
- When this parameter is true, the container is given read-only access to its root file system.ContainerDetail.Builder ulimits(Collection<Ulimit> ulimits)
A list of ulimit
values to set in the container.
ulimits
- A list of ulimit
values to set in the container.ContainerDetail.Builder ulimits(Ulimit... ulimits)
A list of ulimit
values to set in the container.
ulimits
- A list of ulimit
values to set in the container.ContainerDetail.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).
privileged
- When this parameter is true, the container is given elevated privileges on the host container instance
(similar to the root
user).ContainerDetail.Builder user(String user)
The user name to use inside the container.
user
- The user name to use inside the container.ContainerDetail.Builder exitCode(Integer exitCode)
The exit code to return upon completion.
exitCode
- The exit code to return upon completion.ContainerDetail.Builder reason(String reason)
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
reason
- A short (255 max characters) human-readable string to provide additional details about a running or
stopped container.ContainerDetail.Builder containerInstanceArn(String containerInstanceArn)
The Amazon Resource Name (ARN) of the container instance on which the container is running.
containerInstanceArn
- The Amazon Resource Name (ARN) of the container instance on which the container is running.ContainerDetail.Builder taskArn(String taskArn)
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each
container attempt receives a task ARN when they reach the STARTING
status.
taskArn
- The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each
container attempt receives a task ARN when they reach the STARTING
status.ContainerDetail.Builder logStreamName(String logStreamName)
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is
/aws/batch/job
. Each container attempt receives a log stream name when they reach the
RUNNING
status.
logStreamName
- The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch
jobs is /aws/batch/job
. Each container attempt receives a log stream name when they reach
the RUNNING
status.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.