Class ContainerDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ContainerDetail.Builder,
ContainerDetail>
An object that represents the details of a container that's part of a job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ContainerDetail.Builder
builder()
command()
The command that's passed to the container.final String
The Amazon Resource Name (ARN) of the container instance that the container is running on.final List
<KeyValuePair> The environment variables to pass to a container.final EphemeralStorage
The amount of ephemeral storage allocated for the task.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the execution role that Batch can assume.final Integer
exitCode()
The exit code returned upon completion.The platform configuration for jobs that are running on Fargate resources.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Command property.final boolean
For responses, this returns true if the service returned a value for the Environment property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MountPoints property.final boolean
For responses, this returns true if the service returned a value for the NetworkInterfaces property.final boolean
For responses, this returns true if the service returned a value for the ResourceRequirements property.final boolean
For responses, this returns true if the service returned a value for the Secrets property.final boolean
For responses, this returns true if the service returned a value for the Ulimits property.final boolean
For responses, this returns true if the service returned a value for the Volumes property.final String
image()
The image used to start the container.final String
The instance type of the underlying host infrastructure of a multi-node parallel job.final String
The Amazon Resource Name (ARN) that's associated with the job when run.final LinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.final LogConfiguration
The log configuration specification for the container.final String
The name of the Amazon CloudWatch Logs log stream that's associated with the container.final Integer
memory()
For jobs running on Amazon EC2 resources that didn't specify memory requirements usingresourceRequirements
, the number of MiB of memory reserved for the job.final List
<MountPoint> The mount points for data volumes in your container.final NetworkConfiguration
The network configuration for jobs that are running on Fargate resources.final List
<NetworkInterface> The network interfaces that are associated with the job.final Boolean
When this parameter is true, the container is given elevated permissions on the host container instance (similar to theroot
user).final Boolean
When this parameter is true, the container is given read-only access to its root file system.final String
reason()
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.final RepositoryCredentials
The private repository authentication credentials to use.final List
<ResourceRequirement> The type and amount of resources to assign to a container.final RuntimePlatform
An object that represents the compute environment architecture for Batch jobs on Fargate.secrets()
The secrets to pass to the container.static Class
<? extends ContainerDetail.Builder> final String
taskArn()
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.ulimits()
A list ofulimit
values to set in the container.final String
user()
The user name to use inside the container.final Integer
vcpus()
The number of vCPUs reserved for the container.volumes()
A list of volumes that are associated with the job.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
image
The image used to start the container.
- Returns:
- The image used to start the container.
-
vcpus
The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you can specify the vCPU requirement for the job using
resourceRequirements
, but you can't specify the vCPU requirements in both thevcpus
andresourceRequirements
object. This parameter maps toCpuShares
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. It must be specified for each node at least once.This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using
resourceRequirements
.- Returns:
- The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you can
specify the vCPU requirement for the job using
resourceRequirements
, but you can't specify the vCPU requirements in both thevcpus
andresourceRequirements
object. This parameter maps toCpuShares
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. It must be specified for each node at least once.This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using
resourceRequirements
.
-
memory
For jobs running on Amazon EC2 resources that didn't specify memory requirements using
resourceRequirements
, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, seeresourceRequirements
.- Returns:
- For jobs running on Amazon EC2 resources that didn't specify memory requirements using
resourceRequirements
, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, seeresourceRequirements
.
-
hasCommand
public final boolean hasCommand()For responses, this returns true if the service returned a value for the Command property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
command
The command that's passed to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCommand()
method.- Returns:
- The command that's passed to the container.
-
jobRoleArn
The Amazon Resource Name (ARN) that's associated with the job when run.
- Returns:
- The Amazon Resource Name (ARN) that's associated with the job when run.
-
executionRoleArn
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
- Returns:
- The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
-
hasVolumes
public final boolean hasVolumes()For responses, this returns true if the service returned a value for the Volumes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
volumes
A list of volumes that are associated with the job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVolumes()
method.- Returns:
- A list of volumes that are associated with the job.
-
hasEnvironment
public final boolean hasEnvironment()For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
environment
The environment variables to pass to a container.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEnvironment()
method.- Returns:
- The environment variables to pass to a container.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.
-
hasMountPoints
public final boolean hasMountPoints()For responses, this returns true if the service returned a value for the MountPoints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
mountPoints
The mount points for data volumes in your container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMountPoints()
method.- Returns:
- The mount points for data volumes in your container.
-
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 todocker run
.- Returns:
- 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 todocker run
.
-
hasUlimits
public final boolean hasUlimits()For responses, this returns true if the service returned a value for the Ulimits property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
ulimits
A list of
ulimit
values to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUlimits()
method.- Returns:
- A list of
ulimit
values to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources.
-
privileged
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the
root
user). The default value isfalse
.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as
false
.- Returns:
- When this parameter is true, the container is given elevated permissions on the host container instance
(similar to the
root
user). The default value isfalse
.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as
false
.
-
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.- Returns:
- 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.
-
exitCode
The exit code returned upon completion.
- Returns:
- The exit code returned upon completion.
-
reason
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
- Returns:
- A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
-
containerInstanceArn
The Amazon Resource Name (ARN) of the container instance that the container is running on.
- Returns:
- The Amazon Resource Name (ARN) of the container instance that the container is running on.
-
taskArn
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the
STARTING
status.- Returns:
- The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each
container attempt receives a task ARN when they reach the
STARTING
status.
-
logStreamName
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
/aws/batch/job
. Each container attempt receives a log stream name when they reach theRUNNING
status.- Returns:
- The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for
Batch jobs is
/aws/batch/job
. Each container attempt receives a log stream name when they reach theRUNNING
status.
-
instanceType
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
- Returns:
- The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
-
hasNetworkInterfaces
public final boolean hasNetworkInterfaces()For responses, this returns true if the service returned a value for the NetworkInterfaces property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
networkInterfaces
The network interfaces that are associated with the job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNetworkInterfaces()
method.- Returns:
- The network interfaces that are associated with the job.
-
hasResourceRequirements
public final boolean hasResourceRequirements()For responses, this returns true if the service returned a value for the ResourceRequirements property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
resourceRequirements
The type and amount of resources to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasResourceRequirements()
method.- Returns:
- The type and amount of resources to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.
-
linuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
- Returns:
- Linux-specific modifications that are applied to the container, such as details for device mappings.
-
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 might 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, alternatively, it must be configured 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.Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might 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 in to 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.- Returns:
- 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 might 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, alternatively, it must be configured 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.Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might 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 in to 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.
-
hasSecrets
public final boolean hasSecrets()For responses, this returns true if the service returned a value for the Secrets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secrets
The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecrets()
method.- Returns:
- The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
-
networkConfiguration
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
- Returns:
- The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
-
fargatePlatformConfiguration
The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
- Returns:
- The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
-
ephemeralStorage
The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
- Returns:
- The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
-
runtimePlatform
An object that represents the compute environment architecture for Batch jobs on Fargate.
- Returns:
- An object that represents the compute environment architecture for Batch jobs on Fargate.
-
repositoryCredentials
The private repository authentication credentials to use.
- Returns:
- The private repository authentication credentials to use.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ContainerDetail.Builder,
ContainerDetail> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-