Class EcsContainerOverride
- java.lang.Object
-
- software.amazon.awssdk.services.pipes.model.EcsContainerOverride
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EcsContainerOverride.Builder,EcsContainerOverride>
@Generated("software.amazon.awssdk:codegen") public final class EcsContainerOverride extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EcsContainerOverride.Builder,EcsContainerOverride>
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, thenameparameter must be included.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEcsContainerOverride.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EcsContainerOverride.Builderbuilder()List<String>command()The command to send to the container that overrides the default command from the Docker image or the task definition.Integercpu()The number ofcpuunits reserved for the container, instead of the default value from the task definition.List<EcsEnvironmentVariable>environment()The environment variables to send to the container.List<EcsEnvironmentFile>environmentFiles()A list of files containing the environment variables to pass to a container, instead of the value from the container definition.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCommand()For responses, this returns true if the service returned a value for the Command property.booleanhasEnvironment()For responses, this returns true if the service returned a value for the Environment property.booleanhasEnvironmentFiles()For responses, this returns true if the service returned a value for the EnvironmentFiles property.inthashCode()booleanhasResourceRequirements()For responses, this returns true if the service returned a value for the ResourceRequirements property.Integermemory()The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.IntegermemoryReservation()The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.Stringname()The name of the container that receives the override.List<EcsResourceRequirement>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 EcsContainerOverride.Builder>serializableBuilderClass()EcsContainerOverride.BuildertoBuilder()StringtoString()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
-
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 theisEmpty()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.
-
cpu
public final Integer cpu()
The number of
cpuunits reserved for the container, instead of the default value from the task definition. You must also specify a container name.- Returns:
- The number of
cpuunits reserved for the container, instead of the default value from 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 theisEmpty()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<EcsEnvironmentVariable> 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 theisEmpty()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<EcsEnvironmentFile> 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.
-
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.
-
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.
-
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 theisEmpty()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<EcsResourceRequirement> 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 EcsContainerOverride.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EcsContainerOverride.Builder,EcsContainerOverride>
-
builder
public static EcsContainerOverride.Builder builder()
-
serializableBuilderClass
public static Class<? extends EcsContainerOverride.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-