software.amazon.awscdk.services.stepfunctions.tasks

Interface ContainerOverride

All Known Implementing Classes:

ContainerOverride.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.175Z")
public interface ContainerOverride

A list of container overrides that specify the name of a container and the overrides it should receive.

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.ecs.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 ContainerDefinition containerDefinition;
 ContainerOverride containerOverride = ContainerOverride.builder()
         .containerDefinition(containerDefinition)
         // the properties below are optional
         .command(List.of("command"))
         .cpu(123)
         .environment(List.of(TaskEnvironmentVariable.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .memoryLimit(123)
         .memoryReservation(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ContainerOverride.Builder	builder()
default java.util.List<java.lang.String>	getCommand() Command to run inside the container.
ContainerDefinition	getContainerDefinition() Name of the container inside the task definition.
default java.lang.Number	getCpu() The number of cpu units reserved for the container.
default java.util.List<TaskEnvironmentVariable>	getEnvironment() The environment variables to send to the container.
default java.lang.Number	getMemoryLimit() The hard limit (in MiB) of memory to present to the container.
default java.lang.Number	getMemoryReservation() The soft limit (in MiB) of memory to reserve for the container.

Method Detail

getContainerDefinition

ContainerDefinition getContainerDefinition()

Name of the container inside the task definition.

getCommand

default java.util.List<java.lang.String> getCommand()

Command to run inside the container.

Default: - Default command from the Docker image or the task definition

getCpu

default java.lang.Number getCpu()

The number of cpu units reserved for the container.

Default: - The default value from the task definition.

getEnvironment

default java.util.List<TaskEnvironmentVariable> 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 task definition.

Default: - The existing environment variables from the Docker image or the task definition

getMemoryLimit

default java.lang.Number getMemoryLimit()

The hard limit (in MiB) of memory to present to the container.

Default: - The default value from the task definition.

getMemoryReservation

default java.lang.Number getMemoryReservation()

The soft limit (in MiB) of memory to reserve for the container.

Default: - The default value from the task definition.

builder

static ContainerOverride.Builder builder()

Returns:

a ContainerOverride.Builder of ContainerOverride