Package software.amazon.awscdk.services.stepfunctions.tasks

Interface BatchContainerOverrides

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BatchContainerOverrides.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:24.419Z")
@Stability(Stable)
public interface BatchContainerOverrides
extends software.amazon.jsii.JsiiSerializable

The overrides that should be sent to a container.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 InstanceType instanceType;
 Size size;
 BatchContainerOverrides batchContainerOverrides = BatchContainerOverrides.builder()
         .command(List.of("command"))
         .environment(Map.of(
                 "environmentKey", "environment"))
         .gpuCount(123)
         .instanceType(instanceType)
         .memory(size)
         .vcpus(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BatchContainerOverrides.Builder	A builder for BatchContainerOverrides
static final class	BatchContainerOverrides.Jsii$Proxy	An implementation for BatchContainerOverrides

Method Summary

Modifier and Type	Method	Description
static BatchContainerOverrides.Builder	builder()
default List<String>	getCommand()	The command to send to the container that overrides the default command from the Docker image or the job definition.
default Map<String,String>	getEnvironment()	The environment variables to send to the container.
default Number	getGpuCount()	The number of physical GPUs to reserve for the container.
default InstanceType	getInstanceType()	The instance type to use for a multi-node parallel job.
default Size	getMemory()	Memory reserved for the job.
default Number	getVcpus()	The number of vCPUs to reserve for the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

The command to send to the container that overrides the default command from the Docker image or the job definition.

Default: - No command overrides

getEnvironment

@Stability(Stable)
@Nullable
default Map<String,String> getEnvironment()

The environment variables to send to the container.

You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Default: - No environment overrides

getGpuCount

@Stability(Stable)
@Nullable
default Number getGpuCount()

The number of physical GPUs to reserve for the container.

The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.

Default: - No GPU reservation

getInstanceType

@Stability(Stable)
@Nullable
default InstanceType getInstanceType()

The instance type to use for a multi-node parallel job.

This parameter is not valid for single-node container jobs.

Default: - No instance type overrides

getMemory

@Stability(Stable)
@Nullable
default Size getMemory()

Memory reserved for the job.

Default: - No memory overrides. The memory supplied in the job definition will be used.

getVcpus

@Stability(Stable)
@Nullable
default Number getVcpus()

The number of vCPUs to reserve for the container.

This value overrides the value set in the job definition.

Default: - No vCPUs overrides

builder

@Stability(Stable)
static BatchContainerOverrides.Builder builder()

Returns:

a BatchContainerOverrides.Builder of BatchContainerOverrides