ContainerOverride (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.ContainerOverride

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ContainerOverride
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContainerOverride()

Constructors
Constructor and Description
`ContainerOverride()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContainerOverride`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCommand()` The command to send to the container that overrides the default command from the Docker image or the task definition.
`Integer`	`getCpu()` The number of `cpu` units reserved for the container, instead of the default value from the task definition.
`List<KeyValuePair>`	`getEnvironment()` The environment variables to send to the container.
`List<EnvironmentFile>`	`getEnvironmentFiles()` A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
`Integer`	`getMemory()` The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
`Integer`	`getMemoryReservation()` The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
`String`	`getName()` The name of the container that receives the override.
`List<ResourceRequirement>`	`getResourceRequirements()` The type and amount of a resource to assign to a container, instead of the default value from the task definition.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCommand(Collection<String> command)` The command to send to the container that overrides the default command from the Docker image or the task definition.
`void`	`setCpu(Integer cpu)` The number of `cpu` units reserved for the container, instead of the default value from the task definition.
`void`	`setEnvironment(Collection<KeyValuePair> environment)` The environment variables to send to the container.
`void`	`setEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)` A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
`void`	`setMemory(Integer memory)` The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
`void`	`setMemoryReservation(Integer memoryReservation)` The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
`void`	`setName(String name)` The name of the container that receives the override.
`void`	`setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)` The type and amount of a resource to assign to a container, instead of the default value from the task definition.
`String`	`toString()` Returns a string representation of this object.
`ContainerOverride`	`withCommand(Collection<String> command)` The command to send to the container that overrides the default command from the Docker image or the task definition.
`ContainerOverride`	`withCommand(String... command)` The command to send to the container that overrides the default command from the Docker image or the task definition.
`ContainerOverride`	`withCpu(Integer cpu)` The number of `cpu` units reserved for the container, instead of the default value from the task definition.
`ContainerOverride`	`withEnvironment(Collection<KeyValuePair> environment)` The environment variables to send to the container.
`ContainerOverride`	`withEnvironment(KeyValuePair... environment)` The environment variables to send to the container.
`ContainerOverride`	`withEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)` A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
`ContainerOverride`	`withEnvironmentFiles(EnvironmentFile... environmentFiles)` A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
`ContainerOverride`	`withMemory(Integer memory)` The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
`ContainerOverride`	`withMemoryReservation(Integer memoryReservation)` The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
`ContainerOverride`	`withName(String name)` The name of the container that receives the override.
`ContainerOverride`	`withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)` The type and amount of a resource to assign to a container, instead of the default value from the task definition.
`ContainerOverride`	`withResourceRequirements(ResourceRequirement... resourceRequirements)` The type and amount of a resource to assign to a container, instead of the default value from the task definition.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ContainerOverride
```
public ContainerOverride()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the container that receives the override. This parameter is required if any override is specified.
    
    Parameters:
    
    name - The name of the container that receives the override. This parameter is required if any override is specified.
  - getName
```
public String getName()
```
    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.
  - withName
```
public ContainerOverride withName(String name)
```
    The name of the container that receives the override. This parameter is required if any override is specified.
    
    Parameters:
    
    name - The name of the container that receives the override. This parameter is required if any override is specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCommand
```
public List<String> getCommand()
```
    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.
    
    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.
  - setCommand
```
public void setCommand(Collection<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.
    
    Parameters:
    
    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.
  - withCommand
```
public ContainerOverride withCommand(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCommand(java.util.Collection) or withCommand(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCommand
```
public ContainerOverride withCommand(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironment
```
public List<KeyValuePair> 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. You must also specify a container name.
    
    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.
  - setEnvironment
```
public void setEnvironment(Collection<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.
    
    Parameters:
    
    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.
  - withEnvironment
```
public ContainerOverride withEnvironment(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setEnvironment(java.util.Collection) or withEnvironment(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnvironment
```
public ContainerOverride withEnvironment(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironmentFiles
```
public List<EnvironmentFile> getEnvironmentFiles()
```
    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
    
    Returns:
    
    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
  - setEnvironmentFiles
```
public void setEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)
```
    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
    
    Parameters:
    
    environmentFiles - A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
  - withEnvironmentFiles
```
public ContainerOverride withEnvironmentFiles(EnvironmentFile... environmentFiles)
```
    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
    
    NOTE: This method appends the values to the existing list (if any). Use setEnvironmentFiles(java.util.Collection) or withEnvironmentFiles(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    environmentFiles - A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnvironmentFiles
```
public ContainerOverride withEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)
```
    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
    
    Parameters:
    
    environmentFiles - A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCpu
```
public void setCpu(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.
    
    Parameters:
    
    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.
  - getCpu
```
public Integer getCpu()
```
    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.
  - withCpu
```
public ContainerOverride withCpu(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMemory
```
public void setMemory(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.
    
    Parameters:
    
    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.
  - getMemory
```
public Integer getMemory()
```
    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.
  - withMemory
```
public ContainerOverride withMemory(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMemoryReservation
```
public void setMemoryReservation(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.
    
    Parameters:
    
    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.
  - getMemoryReservation
```
public Integer getMemoryReservation()
```
    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.
  - withMemoryReservation
```
public ContainerOverride withMemoryReservation(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceRequirements
```
public List<ResourceRequirement> getResourceRequirements()
```
    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.
    
    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.
  - setResourceRequirements
```
public void setResourceRequirements(Collection<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.
    
    Parameters:
    
    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.
  - withResourceRequirements
```
public ContainerOverride withResourceRequirements(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceRequirements(java.util.Collection) or withResourceRequirements(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceRequirements
```
public ContainerOverride withResourceRequirements(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ContainerOverride clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class ContainerOverride

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerOverride

Method Detail

setName

getName

withName

getCommand

setCommand

withCommand

withCommand

getEnvironment

setEnvironment

withEnvironment

withEnvironment

getEnvironmentFiles

setEnvironmentFiles

withEnvironmentFiles

withEnvironmentFiles

setCpu

getCpu

withCpu

setMemory

getMemory

withMemory

setMemoryReservation

getMemoryReservation

withMemoryReservation

getResourceRequirements

setResourceRequirements

withResourceRequirements

withResourceRequirements

toString

equals

hashCode

clone

marshall