ContainerDetail.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<ContainerDetail.Builder,ContainerDetail>, SdkBuilder<ContainerDetail.Builder,ContainerDetail>, SdkPojo

Enclosing class:

ContainerDetail
```
public static interface ContainerDetail.Builder
extends SdkPojo, CopyableBuilder<ContainerDetail.Builder,ContainerDetail>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ContainerDetail.Builder`	`command(Collection<String> command)` The command that's passed to the container.
`ContainerDetail.Builder`	`command(String... command)` The command that's passed to the container.
`ContainerDetail.Builder`	`containerInstanceArn(String containerInstanceArn)` The Amazon Resource Name (ARN) of the container instance that the container is running on.
`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 Batch can assume.
`ContainerDetail.Builder`	`exitCode(Integer exitCode)` The exit code to return upon completion.
`default ContainerDetail.Builder`	`fargatePlatformConfiguration(Consumer<FargatePlatformConfiguration.Builder> fargatePlatformConfiguration)` The platform configuration for jobs that are running on Fargate resources.
`ContainerDetail.Builder`	`fargatePlatformConfiguration(FargatePlatformConfiguration fargatePlatformConfiguration)` The platform configuration for jobs that are running on Fargate resources.
`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)` For jobs run on EC2 resources that didn't specify memory requirements using `ResourceRequirement`, 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.
`default ContainerDetail.Builder`	`networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)` The network configuration for jobs that are running on Fargate resources.
`ContainerDetail.Builder`	`networkConfiguration(NetworkConfiguration networkConfiguration)` The network configuration for jobs that are running on Fargate resources.
`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 permissions 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 resources to assign to a container.
`ContainerDetail.Builder`	`resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements)` The type and amount of resources to assign to a container.
`ContainerDetail.Builder`	`resourceRequirements(ResourceRequirement... resourceRequirements)` The type and amount of resources 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's 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 reserved for the container.
`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.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - image
```
ContainerDetail.Builder image(String image)
```
    The image used to start the container.
    
    Parameters:
    
    image - The image used to start the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vcpus
```
ContainerDetail.Builder vcpus(Integer vcpus)
```
    The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirement object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 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.
    
    Parameters:
    
    vcpus - The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirement object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - memory
```
ContainerDetail.Builder memory(Integer memory)
```
    For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
    
    Parameters:
    
    memory - For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - command
```
ContainerDetail.Builder command(Collection<String> command)
```
    The command that's passed to the container.
    
    Parameters:
    
    command - The command that's passed to the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - command
```
ContainerDetail.Builder command(String... command)
```
    The command that's passed to the container.
    
    Parameters:
    
    command - The command that's passed to the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobRoleArn
```
ContainerDetail.Builder jobRoleArn(String jobRoleArn)
```
    The Amazon Resource Name (ARN) associated with the job upon execution.
    
    Parameters:
    
    jobRoleArn - The Amazon Resource Name (ARN) associated with the job upon execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - executionRoleArn
```
ContainerDetail.Builder executionRoleArn(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - volumes
```
ContainerDetail.Builder volumes(Collection<Volume> volumes)
```
    A list of volumes associated with the job.
    
    Parameters:
    
    volumes - A list of volumes associated with the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - volumes
```
ContainerDetail.Builder volumes(Volume... volumes)
```
    A list of volumes associated with the job.
    
    Parameters:
    
    volumes - A list of volumes associated with the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - volumes
```
ContainerDetail.Builder volumes(Consumer<Volume.Builder>... volumes)
```
    A list of volumes associated with the job.
    This is a convenience that creates an instance of the 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 #volumes(List).
    
    Parameters:
    
    volumes - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #volumes(List)
  - environment
```
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 Batch service.
    
    Parameters:
    
    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 Batch service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - environment
```
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 Batch service.
    
    Parameters:
    
    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 Batch service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - environment
```
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 Batch service.
    This is a convenience that creates an instance of the 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).
    
    Parameters:
    
    environment - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #environment(List)
  - mountPoints
```
ContainerDetail.Builder mountPoints(Collection<MountPoint> mountPoints)
```
    The mount points for data volumes in your container.
    
    Parameters:
    
    mountPoints - The mount points for data volumes in your container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mountPoints
```
ContainerDetail.Builder mountPoints(MountPoint... mountPoints)
```
    The mount points for data volumes in your container.
    
    Parameters:
    
    mountPoints - The mount points for data volumes in your container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mountPoints
```
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 the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #mountPoints(List).
    
    Parameters:
    
    mountPoints - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #mountPoints(List)
  - readonlyRootFilesystem
```
ContainerDetail.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)
```
    When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
    
    Parameters:
    
    readonlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ulimits
```
ContainerDetail.Builder ulimits(Collection<Ulimit> ulimits)
```
    A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
    
    This parameter isn't applicable to jobs that are running on Fargate resources.
    
    Parameters:
    
    ulimits - A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
    
    This parameter isn't applicable to jobs that are running on Fargate resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ulimits
```
ContainerDetail.Builder ulimits(Ulimit... ulimits)
```
    A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
    
    This parameter isn't applicable to jobs that are running on Fargate resources.
    
    Parameters:
    
    ulimits - A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
    
    This parameter isn't applicable to jobs that are running on Fargate resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ulimits
```
ContainerDetail.Builder ulimits(Consumer<Ulimit.Builder>... ulimits)
```
    A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
    
    This parameter isn't applicable to jobs that are running on Fargate resources.
    This is a convenience that creates an instance of the 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).
    
    Parameters:
    
    ulimits - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #ulimits(List)
  - privileged
```
ContainerDetail.Builder privileged(Boolean 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 is false.
    
    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
    
    Parameters:
    
    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 is false.
    
    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - user
```
ContainerDetail.Builder user(String user)
```
    The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - exitCode
```
ContainerDetail.Builder exitCode(Integer exitCode)
```
    The exit code to return upon completion.
    
    Parameters:
    
    exitCode - The exit code to return upon completion.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - reason
```
ContainerDetail.Builder reason(String reason)
```
    A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
    
    Parameters:
    
    reason - A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - containerInstanceArn
```
ContainerDetail.Builder containerInstanceArn(String containerInstanceArn)
```
    The Amazon Resource Name (ARN) of the container instance that the container is running on.
    
    Parameters:
    
    containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that the container is running on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskArn
```
ContainerDetail.Builder taskArn(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - logStreamName
```
ContainerDetail.Builder logStreamName(String logStreamName)
```
    The name of the CloudWatch Logs log stream 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 the RUNNING status.
    
    Parameters:
    
    logStreamName - The name of the CloudWatch Logs log stream 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 the RUNNING status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceType
```
ContainerDetail.Builder instanceType(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkInterfaces
```
ContainerDetail.Builder networkInterfaces(Collection<NetworkInterface> networkInterfaces)
```
    The network interfaces associated with the job.
    
    Parameters:
    
    networkInterfaces - The network interfaces associated with the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkInterfaces
```
ContainerDetail.Builder networkInterfaces(NetworkInterface... networkInterfaces)
```
    The network interfaces associated with the job.
    
    Parameters:
    
    networkInterfaces - The network interfaces associated with the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkInterfaces
```
ContainerDetail.Builder networkInterfaces(Consumer<NetworkInterface.Builder>... networkInterfaces)
```
    The network interfaces associated with the job.
    This is a convenience that creates an instance of the 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 #networkInterfaces(List).
    
    Parameters:
    
    networkInterfaces - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #networkInterfaces(List)
  - resourceRequirements
```
ContainerDetail.Builder resourceRequirements(Collection<ResourceRequirement> resourceRequirements)
```
    The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
    
    Parameters:
    
    resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceRequirements
```
ContainerDetail.Builder resourceRequirements(ResourceRequirement... resourceRequirements)
```
    The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
    
    Parameters:
    
    resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceRequirements
```
ContainerDetail.Builder resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements)
```
    The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
    This is a convenience that creates an instance of the 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).
    
    Parameters:
    
    resourceRequirements - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #resourceRequirements(List)
  - linuxParameters
```
ContainerDetail.Builder linuxParameters(LinuxParameters linuxParameters)
```
    Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Parameters:
    
    linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - linuxParameters
```
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 the LinuxParameters.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).
    
    Parameters:
    
    linuxParameters - a consumer that will call methods on LinuxParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    linuxParameters(LinuxParameters)
  - logConfiguration
```
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 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 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.
    
    Parameters:
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - logConfiguration
```
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 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 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 is a convenience that creates an instance of the 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).
    
    Parameters:
    
    logConfiguration - a consumer that will call methods on LogConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    logConfiguration(LogConfiguration)
  - secrets
```
ContainerDetail.Builder secrets(Collection<Secret> secrets)
```
    The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
    
    Parameters:
    
    secrets - The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - secrets
```
ContainerDetail.Builder secrets(Secret... secrets)
```
    The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
    
    Parameters:
    
    secrets - The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - secrets
```
ContainerDetail.Builder secrets(Consumer<Secret.Builder>... secrets)
```
    The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
    This is a convenience that creates an instance of the 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 #secrets(List).
    
    Parameters:
    
    secrets - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #secrets(List)
  - networkConfiguration
```
ContainerDetail.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
```
    The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
    
    Parameters:
    
    networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkConfiguration
```
default ContainerDetail.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
```
    The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
    This is a convenience that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).
    
    Parameters:
    
    networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    networkConfiguration(NetworkConfiguration)
  - fargatePlatformConfiguration
```
ContainerDetail.Builder fargatePlatformConfiguration(FargatePlatformConfiguration fargatePlatformConfiguration)
```
    The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
    
    Parameters:
    
    fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - fargatePlatformConfiguration
```
default ContainerDetail.Builder fargatePlatformConfiguration(Consumer<FargatePlatformConfiguration.Builder> fargatePlatformConfiguration)
```
    The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
    This is a convenience that creates an instance of the FargatePlatformConfiguration.Builder avoiding the need to create one manually via FargatePlatformConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fargatePlatformConfiguration(FargatePlatformConfiguration).
    
    Parameters:
    
    fargatePlatformConfiguration - a consumer that will call methods on FargatePlatformConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    fargatePlatformConfiguration(FargatePlatformConfiguration)

Interface ContainerDetail.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

image

vcpus

memory

command

command

jobRoleArn

executionRoleArn

volumes

volumes

volumes

environment

environment

environment

mountPoints

mountPoints

mountPoints

readonlyRootFilesystem

ulimits

ulimits

ulimits

privileged

user

exitCode

reason

containerInstanceArn

taskArn

logStreamName

instanceType

networkInterfaces

networkInterfaces

networkInterfaces

resourceRequirements

resourceRequirements

resourceRequirements

linuxParameters

linuxParameters

logConfiguration

logConfiguration

secrets

secrets

secrets

networkConfiguration

networkConfiguration

fargatePlatformConfiguration

fargatePlatformConfiguration