public static interface ContainerDetail.Builder extends SdkPojo, 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(Consumer<KeyValuePair.Builder>... environment)
The environment variables to pass to a container.
|
ContainerDetail.Builder |
environment(KeyValuePair... environment)
The environment variables to pass to a container.
|
ContainerDetail.Builder |
executionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
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 |
instanceType(String instanceType)
The instance type of the underlying host infrastructure of a multi-node parallel job.
|
ContainerDetail.Builder |
jobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) associated with the job upon execution.
|
default ContainerDetail.Builder |
linuxParameters(Consumer<LinuxParameters.Builder> linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
ContainerDetail.Builder |
linuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
default ContainerDetail.Builder |
logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration)
The log configuration specification for the container.
|
ContainerDetail.Builder |
logConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
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(Consumer<MountPoint.Builder>... 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 |
networkInterfaces(Collection<NetworkInterface> networkInterfaces)
The network interfaces associated with the job.
|
ContainerDetail.Builder |
networkInterfaces(Consumer<NetworkInterface.Builder>... networkInterfaces)
The network interfaces associated with the job.
|
ContainerDetail.Builder |
networkInterfaces(NetworkInterface... networkInterfaces)
The network interfaces associated with the job.
|
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 |
resourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDetail.Builder |
resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDetail.Builder |
resourceRequirements(ResourceRequirement... resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDetail.Builder |
secrets(Collection<Secret> secrets)
The secrets to pass to the container.
|
ContainerDetail.Builder |
secrets(Consumer<Secret.Builder>... secrets)
The secrets to pass to the container.
|
ContainerDetail.Builder |
secrets(Secret... secrets)
The secrets to pass to the 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(Consumer<Ulimit.Builder>... 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(Consumer<Volume.Builder>... volumes)
A list of volumes associated with the job.
|
ContainerDetail.Builder |
volumes(Volume... volumes)
A list of volumes associated with the job.
|
equalsBySdkFields, sdkFields
copy
applyMutation, 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. This is a required parameter.
vcpus
- The number of VCPUs allocated for the job. This is a required parameter.ContainerDetail.Builder memory(Integer memory)
The number of MiB of memory reserved for the job. This is a required parameter.
memory
- The number of MiB of memory reserved for the job. This is a required parameter.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 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.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 volumes(Consumer<Volume.Builder>... volumes)
A list of volumes associated with the 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)
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 environment(Consumer<KeyValuePair.Builder>... 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.
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)
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 mountPoints(Consumer<MountPoint.Builder>... mountPoints)
The mount points for data volumes in your container.
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 #mountPoints(List)
.mountPoints
- a consumer that will call methods on List.Builder
#mountPoints(List)
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 ulimits(Consumer<Ulimit.Builder>... ulimits)
A list of ulimit
values to set in the container.
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)
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.ContainerDetail.Builder instanceType(String instanceType)
The instance type of the underlying host infrastructure of a multi-node parallel job.
instanceType
- The instance type of the underlying host infrastructure of a multi-node parallel job.ContainerDetail.Builder networkInterfaces(Collection<NetworkInterface> networkInterfaces)
The network interfaces associated with the job.
networkInterfaces
- The network interfaces associated with the job.ContainerDetail.Builder networkInterfaces(NetworkInterface... networkInterfaces)
The network interfaces associated with the job.
networkInterfaces
- The network interfaces associated with the job.ContainerDetail.Builder networkInterfaces(Consumer<NetworkInterface.Builder>... networkInterfaces)
The network interfaces associated with the 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 #networkInterfaces(List)
.networkInterfaces
- a consumer that will call methods on List.Builder
#networkInterfaces(List)
ContainerDetail.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
.ContainerDetail.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
.ContainerDetail.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)
ContainerDetail.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 ContainerDetail.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.Builder
linuxParameters(LinuxParameters)
ContainerDetail.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). Additional log drivers may be available in future releases of the Amazon ECS container agent.
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). Additional log drivers may be available in future releases of the Amazon ECS container agent.
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 ContainerDetail.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). Additional log drivers may be available in future releases of the Amazon ECS container agent.
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.Builder
logConfiguration(LogConfiguration)
ContainerDetail.Builder secrets(Collection<Secret> secrets)
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.ContainerDetail.Builder secrets(Secret... secrets)
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.ContainerDetail.Builder secrets(Consumer<Secret.Builder>... secrets)
The secrets to pass to 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.