@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ContainerDetail extends Object implements Serializable, Cloneable, StructuredPojo
An object representing the details of a container that is part of a job.
Constructor and Description |
---|
ContainerDetail() |
Modifier and Type | Method and Description |
---|---|
ContainerDetail |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCommand()
The command that is passed to the container.
|
String |
getContainerInstanceArn()
The Amazon Resource Name (ARN) of the container instance on which the container is running.
|
List<KeyValuePair> |
getEnvironment()
The environment variables to pass to a container.
|
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
Integer |
getExitCode()
The exit code to return upon completion.
|
String |
getImage()
The image used to start the container.
|
String |
getInstanceType()
The instance type of the underlying host infrastructure of a multi-node parallel job.
|
String |
getJobRoleArn()
The Amazon Resource Name (ARN) associated with the job upon execution.
|
LinuxParameters |
getLinuxParameters()
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
LogConfiguration |
getLogConfiguration()
The log configuration specification for the container.
|
String |
getLogStreamName()
The name of the CloudWatch Logs log stream associated with the container.
|
Integer |
getMemory()
The number of MiB of memory reserved for the job.
|
List<MountPoint> |
getMountPoints()
The mount points for data volumes in your container.
|
List<NetworkInterface> |
getNetworkInterfaces()
The network interfaces associated with the job.
|
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.
|
String |
getReason()
A short (255 max characters) human-readable string to provide additional details about a running or stopped
container.
|
List<ResourceRequirement> |
getResourceRequirements()
The type and amount of a resource to assign to a container.
|
List<Secret> |
getSecrets()
The secrets to pass to the container.
|
String |
getTaskArn()
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
|
List<Ulimit> |
getUlimits()
A list of
ulimit values to set in the container. |
String |
getUser()
The user name to use inside the container.
|
Integer |
getVcpus()
The number of VCPUs allocated for the job.
|
List<Volume> |
getVolumes()
A list of volumes associated with the 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) |
void |
setCommand(Collection<String> command)
The command that is passed to the container.
|
void |
setContainerInstanceArn(String containerInstanceArn)
The Amazon Resource Name (ARN) of the container instance on which the container is running.
|
void |
setEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
|
void |
setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
void |
setExitCode(Integer exitCode)
The exit code to return upon completion.
|
void |
setImage(String image)
The image used to start the container.
|
void |
setInstanceType(String instanceType)
The instance type of the underlying host infrastructure of a multi-node parallel job.
|
void |
setJobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) associated with the job upon execution.
|
void |
setLinuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
void |
setLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
void |
setLogStreamName(String logStreamName)
The name of the CloudWatch Logs log stream associated with the container.
|
void |
setMemory(Integer memory)
The number of MiB of memory reserved for the job.
|
void |
setMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
|
void |
setNetworkInterfaces(Collection<NetworkInterface> networkInterfaces)
The network interfaces associated with the job.
|
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 |
setReason(String reason)
A short (255 max characters) human-readable string to provide additional details about a running or stopped
container.
|
void |
setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container.
|
void |
setSecrets(Collection<Secret> secrets)
The secrets to pass to the container.
|
void |
setTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
|
void |
setUlimits(Collection<Ulimit> ulimits)
A list of
ulimit values 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 allocated for the job.
|
void |
setVolumes(Collection<Volume> volumes)
A list of volumes associated with the job.
|
String |
toString()
Returns a string representation of this object.
|
ContainerDetail |
withCommand(Collection<String> command)
The command that is passed to the container.
|
ContainerDetail |
withCommand(String... command)
The command that is passed to the container.
|
ContainerDetail |
withContainerInstanceArn(String containerInstanceArn)
The Amazon Resource Name (ARN) of the container instance on which the container is running.
|
ContainerDetail |
withEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
|
ContainerDetail |
withEnvironment(KeyValuePair... environment)
The environment variables to pass to a container.
|
ContainerDetail |
withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
ContainerDetail |
withExitCode(Integer exitCode)
The exit code to return upon completion.
|
ContainerDetail |
withImage(String image)
The image used to start the container.
|
ContainerDetail |
withInstanceType(String instanceType)
The instance type of the underlying host infrastructure of a multi-node parallel job.
|
ContainerDetail |
withJobRoleArn(String jobRoleArn)
The Amazon Resource Name (ARN) associated with the job upon execution.
|
ContainerDetail |
withLinuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
ContainerDetail |
withLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
ContainerDetail |
withLogStreamName(String logStreamName)
The name of the CloudWatch Logs log stream associated with the container.
|
ContainerDetail |
withMemory(Integer memory)
The number of MiB of memory reserved for the job.
|
ContainerDetail |
withMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
|
ContainerDetail |
withMountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
|
ContainerDetail |
withNetworkInterfaces(Collection<NetworkInterface> networkInterfaces)
The network interfaces associated with the job.
|
ContainerDetail |
withNetworkInterfaces(NetworkInterface... networkInterfaces)
The network interfaces associated with the job.
|
ContainerDetail |
withPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the
root user). |
ContainerDetail |
withReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system.
|
ContainerDetail |
withReason(String reason)
A short (255 max characters) human-readable string to provide additional details about a running or stopped
container.
|
ContainerDetail |
withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDetail |
withResourceRequirements(ResourceRequirement... resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDetail |
withSecrets(Collection<Secret> secrets)
The secrets to pass to the container.
|
ContainerDetail |
withSecrets(Secret... secrets)
The secrets to pass to the container.
|
ContainerDetail |
withTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
|
ContainerDetail |
withUlimits(Collection<Ulimit> ulimits)
A list of
ulimit values to set in the container. |
ContainerDetail |
withUlimits(Ulimit... ulimits)
A list of
ulimit values to set in the container. |
ContainerDetail |
withUser(String user)
The user name to use inside the container.
|
ContainerDetail |
withVcpus(Integer vcpus)
The number of VCPUs allocated for the job.
|
ContainerDetail |
withVolumes(Collection<Volume> volumes)
A list of volumes associated with the job.
|
ContainerDetail |
withVolumes(Volume... volumes)
A list of volumes associated with the job.
|
public void setImage(String image)
The image used to start the container.
image
- The image used to start the container.public String getImage()
The image used to start the container.
public ContainerDetail withImage(String image)
The image used to start the container.
image
- The image used to start the container.public void setVcpus(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.public Integer getVcpus()
The number of VCPUs allocated for the job. This is a required parameter.
public ContainerDetail withVcpus(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.public void setMemory(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.public Integer getMemory()
The number of MiB of memory reserved for the job. This is a required parameter.
public ContainerDetail withMemory(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.public List<String> getCommand()
The command that is passed to the container.
public void setCommand(Collection<String> command)
The command that is passed to the container.
command
- The command that is passed to the container.public ContainerDetail withCommand(String... command)
The command that is passed to the container.
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.
command
- The command that is passed to the container.public ContainerDetail withCommand(Collection<String> command)
The command that is passed to the container.
command
- The command that is passed to the container.public void setJobRoleArn(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.public String getJobRoleArn()
The Amazon Resource Name (ARN) associated with the job upon execution.
public ContainerDetail withJobRoleArn(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.public void setExecutionRoleArn(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.public String getExecutionRoleArn()
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.
public ContainerDetail withExecutionRoleArn(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.public List<Volume> getVolumes()
A list of volumes associated with the job.
public void setVolumes(Collection<Volume> volumes)
A list of volumes associated with the job.
volumes
- A list of volumes associated with the job.public ContainerDetail withVolumes(Volume... volumes)
A list of volumes associated with the 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.
volumes
- A list of volumes associated with the job.public ContainerDetail withVolumes(Collection<Volume> volumes)
A list of volumes associated with the job.
volumes
- A list of volumes associated with the job.public List<KeyValuePair> getEnvironment()
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 variables must not start with AWS_BATCH
; this naming convention is reserved for
variables that are set by the AWS Batch service.
public void setEnvironment(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.
public ContainerDetail withEnvironment(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.
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.
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.
public ContainerDetail withEnvironment(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.
public List<MountPoint> getMountPoints()
The mount points for data volumes in your container.
public void setMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
mountPoints
- The mount points for data volumes in your container.public ContainerDetail withMountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
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.
mountPoints
- The mount points for data volumes in your container.public ContainerDetail withMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
mountPoints
- The mount points for data volumes in your container.public void setReadonlyRootFilesystem(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.public Boolean getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system.
public ContainerDetail withReadonlyRootFilesystem(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.public Boolean isReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system.
public List<Ulimit> getUlimits()
A list of ulimit
values to set in the container.
ulimit
values to set in the container.public void setUlimits(Collection<Ulimit> ulimits)
A list of ulimit
values to set in the container.
ulimits
- A list of ulimit
values to set in the container.public ContainerDetail withUlimits(Ulimit... ulimits)
A list of ulimit
values to set in the container.
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.
ulimits
- A list of ulimit
values to set in the container.public ContainerDetail withUlimits(Collection<Ulimit> ulimits)
A list of ulimit
values to set in the container.
ulimits
- A list of ulimit
values to set in the container.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).
privileged
- When this parameter is true, the container is given elevated privileges on the host container instance
(similar to the root
user).public Boolean getPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root
user).
root
user).public ContainerDetail withPrivileged(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).public Boolean isPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root
user).
root
user).public void setUser(String user)
The user name to use inside the container.
user
- The user name to use inside the container.public String getUser()
The user name to use inside the container.
public ContainerDetail withUser(String user)
The user name to use inside the container.
user
- The user name to use inside the container.public void setExitCode(Integer exitCode)
The exit code to return upon completion.
exitCode
- The exit code to return upon completion.public Integer getExitCode()
The exit code to return upon completion.
public ContainerDetail withExitCode(Integer exitCode)
The exit code to return upon completion.
exitCode
- The exit code to return upon completion.public void setReason(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.public String getReason()
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
public ContainerDetail withReason(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.public void setContainerInstanceArn(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.public String getContainerInstanceArn()
The Amazon Resource Name (ARN) of the container instance on which the container is running.
public ContainerDetail withContainerInstanceArn(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.public void setTaskArn(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.public String getTaskArn()
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.
STARTING
status.public ContainerDetail withTaskArn(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.public void setLogStreamName(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.public String getLogStreamName()
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.
/aws/batch/job
. Each container attempt receives a log stream name when they reach
the RUNNING
status.public ContainerDetail withLogStreamName(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.public void setInstanceType(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.public String getInstanceType()
The instance type of the underlying host infrastructure of a multi-node parallel job.
public ContainerDetail withInstanceType(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.public List<NetworkInterface> getNetworkInterfaces()
The network interfaces associated with the job.
public void setNetworkInterfaces(Collection<NetworkInterface> networkInterfaces)
The network interfaces associated with the job.
networkInterfaces
- The network interfaces associated with the job.public ContainerDetail withNetworkInterfaces(NetworkInterface... networkInterfaces)
The network interfaces associated with the job.
NOTE: This method appends the values to the existing list (if any). Use
setNetworkInterfaces(java.util.Collection)
or withNetworkInterfaces(java.util.Collection)
if
you want to override the existing values.
networkInterfaces
- The network interfaces associated with the job.public ContainerDetail withNetworkInterfaces(Collection<NetworkInterface> networkInterfaces)
The network interfaces associated with the job.
networkInterfaces
- The network interfaces associated with the job.public List<ResourceRequirement> getResourceRequirements()
The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU
.
GPU
.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
.
resourceRequirements
- The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU
.public ContainerDetail 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.
resourceRequirements
- The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU
.public ContainerDetail withResourceRequirements(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
.public void setLinuxParameters(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.public LinuxParameters getLinuxParameters()
Linux-specific modifications that are applied to the container, such as details for device mappings.
public ContainerDetail withLinuxParameters(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.public void setLogConfiguration(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.
public LogConfiguration getLogConfiguration()
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.
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.
public ContainerDetail withLogConfiguration(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.
public List<Secret> getSecrets()
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
public void setSecrets(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.public ContainerDetail withSecrets(Secret... secrets)
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setSecrets(java.util.Collection)
or withSecrets(java.util.Collection)
if you want to override
the existing values.
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.public ContainerDetail withSecrets(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.public String toString()
toString
in class Object
Object.toString()
public ContainerDetail clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2020. All rights reserved.