software.amazon.awssdk.services.ecs.model

Class ContainerOverride

java.lang.Object

software.amazon.awssdk.services.ecs.model.ContainerOverride

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerOverride.Builder,ContainerOverride>

@Generated(value="software.amazon.awssdk:codegen")
public final class ContainerOverride
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerOverride.Builder,ContainerOverride>

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContainerOverride.Builder

Method Summary

Modifier and Type	Method and Description
static ContainerOverride.Builder	builder()
List<String>	command() The command to send to the container that overrides the default command from the Docker image or the task definition.
Integer	cpu() The number of cpu units reserved for the container, instead of the default value from the task definition.
List<KeyValuePair>	environment() The environment variables to send to the container.
List<EnvironmentFile>	environmentFiles() A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCommand() For responses, this returns true if the service returned a value for the Command property.
boolean	hasEnvironment() For responses, this returns true if the service returned a value for the Environment property.
boolean	hasEnvironmentFiles() For responses, this returns true if the service returned a value for the EnvironmentFiles property.
int	hashCode()
boolean	hasResourceRequirements() For responses, this returns true if the service returned a value for the ResourceRequirements property.
Integer	memory() The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
Integer	memoryReservation() The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
String	name() The name of the container that receives the override.
List<ResourceRequirement>	resourceRequirements() The type and amount of a resource to assign to a container, instead of the default value from the task definition.
List<SdkField<?>>	sdkFields()
static Class<? extends ContainerOverride.Builder>	serializableBuilderClass()
ContainerOverride.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the container that receives the override. This parameter is required if any override is specified.

Returns:

The name of the container that receives the override. This parameter is required if any override is specified.

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 the isEmpty() 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

public final List<String> command()

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

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 to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

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 the isEmpty() 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

public final List<KeyValuePair> environment()

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. You must also specify a container name.

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 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. You must also specify a container name.

hasEnvironmentFiles

public final boolean hasEnvironmentFiles()

For responses, this returns true if the service returned a value for the EnvironmentFiles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

environmentFiles

public final List<EnvironmentFile> environmentFiles()

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

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 hasEnvironmentFiles() method.

Returns:

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

cpu

public final Integer cpu()

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

Returns:

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

memory

public final Integer memory()

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

Returns:

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

memoryReservation

public final Integer memoryReservation()

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

Returns:

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

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 the isEmpty() 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

public final List<ResourceRequirement> resourceRequirements()

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

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 a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

toBuilder

public ContainerOverride.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContainerOverride.Builder,ContainerOverride>

builder

public static ContainerOverride.Builder builder()

serializableBuilderClass

public static Class<? extends ContainerOverride.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo