software.amazon.awscdk.services.stepfunctions.tasks

Interface ContainerOverrides

All Known Implementing Classes:

ContainerOverrides.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:00.884Z")
public interface ContainerOverrides

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.services.ec2.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 InstanceType instanceType;
 ContainerOverrides containerOverrides = ContainerOverrides.builder()
         .command(List.of("command"))
         .environment(Map.of(
                 "environmentKey", "environment"))
         .gpuCount(123)
         .instanceType(instanceType)
         .memory(123)
         .vcpus(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ContainerOverrides.Builder	builder()
default java.util.List<java.lang.String>	getCommand() The command to send to the container that overrides the default command from the Docker image or the job definition.
default java.util.Map<java.lang.String,java.lang.String>	getEnvironment() The environment variables to send to the container.
default java.lang.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 java.lang.Number	getMemory() The number of MiB of memory reserved for the job.
default java.lang.Number	getVcpus() The number of vCPUs to reserve for the container.

Method Detail

getCommand

default java.util.List<java.lang.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

default java.util.Map<java.lang.String,java.lang.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

default java.lang.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

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

default java.lang.Number getMemory()

The number of MiB of memory reserved for the job.

This value overrides the value set in the job definition.

Default: - No memory overrides

getVcpus

default java.lang.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

static ContainerOverrides.Builder builder()

Returns:

a ContainerOverrides.Builder of ContainerOverrides