AWS SDK for C++  1.9.40
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::ContainerDefinition Class Reference

#include <ContainerDefinition.h>

Public Member Functions

 ContainerDefinition ()
 
 ContainerDefinition (Aws::Utils::Json::JsonView jsonValue)
 
ContainerDefinitionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ContainerDefinitionWithName (const Aws::String &value)
 
ContainerDefinitionWithName (Aws::String &&value)
 
ContainerDefinitionWithName (const char *value)
 
const Aws::StringGetImage () const
 
bool ImageHasBeenSet () const
 
void SetImage (const Aws::String &value)
 
void SetImage (Aws::String &&value)
 
void SetImage (const char *value)
 
ContainerDefinitionWithImage (const Aws::String &value)
 
ContainerDefinitionWithImage (Aws::String &&value)
 
ContainerDefinitionWithImage (const char *value)
 
const RepositoryCredentialsGetRepositoryCredentials () const
 
bool RepositoryCredentialsHasBeenSet () const
 
void SetRepositoryCredentials (const RepositoryCredentials &value)
 
void SetRepositoryCredentials (RepositoryCredentials &&value)
 
ContainerDefinitionWithRepositoryCredentials (const RepositoryCredentials &value)
 
ContainerDefinitionWithRepositoryCredentials (RepositoryCredentials &&value)
 
int GetCpu () const
 
bool CpuHasBeenSet () const
 
void SetCpu (int value)
 
ContainerDefinitionWithCpu (int value)
 
int GetMemory () const
 
bool MemoryHasBeenSet () const
 
void SetMemory (int value)
 
ContainerDefinitionWithMemory (int value)
 
int GetMemoryReservation () const
 
bool MemoryReservationHasBeenSet () const
 
void SetMemoryReservation (int value)
 
ContainerDefinitionWithMemoryReservation (int value)
 
const Aws::Vector< Aws::String > & GetLinks () const
 
bool LinksHasBeenSet () const
 
void SetLinks (const Aws::Vector< Aws::String > &value)
 
void SetLinks (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionWithLinks (const Aws::Vector< Aws::String > &value)
 
ContainerDefinitionWithLinks (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionAddLinks (const Aws::String &value)
 
ContainerDefinitionAddLinks (Aws::String &&value)
 
ContainerDefinitionAddLinks (const char *value)
 
const Aws::Vector< PortMapping > & GetPortMappings () const
 
bool PortMappingsHasBeenSet () const
 
void SetPortMappings (const Aws::Vector< PortMapping > &value)
 
void SetPortMappings (Aws::Vector< PortMapping > &&value)
 
ContainerDefinitionWithPortMappings (const Aws::Vector< PortMapping > &value)
 
ContainerDefinitionWithPortMappings (Aws::Vector< PortMapping > &&value)
 
ContainerDefinitionAddPortMappings (const PortMapping &value)
 
ContainerDefinitionAddPortMappings (PortMapping &&value)
 
bool GetEssential () const
 
bool EssentialHasBeenSet () const
 
void SetEssential (bool value)
 
ContainerDefinitionWithEssential (bool value)
 
const Aws::Vector< Aws::String > & GetEntryPoint () const
 
bool EntryPointHasBeenSet () const
 
void SetEntryPoint (const Aws::Vector< Aws::String > &value)
 
void SetEntryPoint (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionWithEntryPoint (const Aws::Vector< Aws::String > &value)
 
ContainerDefinitionWithEntryPoint (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionAddEntryPoint (const Aws::String &value)
 
ContainerDefinitionAddEntryPoint (Aws::String &&value)
 
ContainerDefinitionAddEntryPoint (const char *value)
 
const Aws::Vector< Aws::String > & GetCommand () const
 
bool CommandHasBeenSet () const
 
void SetCommand (const Aws::Vector< Aws::String > &value)
 
void SetCommand (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionWithCommand (const Aws::Vector< Aws::String > &value)
 
ContainerDefinitionWithCommand (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionAddCommand (const Aws::String &value)
 
ContainerDefinitionAddCommand (Aws::String &&value)
 
ContainerDefinitionAddCommand (const char *value)
 
const Aws::Vector< KeyValuePair > & GetEnvironment () const
 
bool EnvironmentHasBeenSet () const
 
void SetEnvironment (const Aws::Vector< KeyValuePair > &value)
 
void SetEnvironment (Aws::Vector< KeyValuePair > &&value)
 
ContainerDefinitionWithEnvironment (const Aws::Vector< KeyValuePair > &value)
 
ContainerDefinitionWithEnvironment (Aws::Vector< KeyValuePair > &&value)
 
ContainerDefinitionAddEnvironment (const KeyValuePair &value)
 
ContainerDefinitionAddEnvironment (KeyValuePair &&value)
 
const Aws::Vector< EnvironmentFile > & GetEnvironmentFiles () const
 
bool EnvironmentFilesHasBeenSet () const
 
void SetEnvironmentFiles (const Aws::Vector< EnvironmentFile > &value)
 
void SetEnvironmentFiles (Aws::Vector< EnvironmentFile > &&value)
 
ContainerDefinitionWithEnvironmentFiles (const Aws::Vector< EnvironmentFile > &value)
 
ContainerDefinitionWithEnvironmentFiles (Aws::Vector< EnvironmentFile > &&value)
 
ContainerDefinitionAddEnvironmentFiles (const EnvironmentFile &value)
 
ContainerDefinitionAddEnvironmentFiles (EnvironmentFile &&value)
 
const Aws::Vector< MountPoint > & GetMountPoints () const
 
bool MountPointsHasBeenSet () const
 
void SetMountPoints (const Aws::Vector< MountPoint > &value)
 
void SetMountPoints (Aws::Vector< MountPoint > &&value)
 
ContainerDefinitionWithMountPoints (const Aws::Vector< MountPoint > &value)
 
ContainerDefinitionWithMountPoints (Aws::Vector< MountPoint > &&value)
 
ContainerDefinitionAddMountPoints (const MountPoint &value)
 
ContainerDefinitionAddMountPoints (MountPoint &&value)
 
const Aws::Vector< VolumeFrom > & GetVolumesFrom () const
 
bool VolumesFromHasBeenSet () const
 
void SetVolumesFrom (const Aws::Vector< VolumeFrom > &value)
 
void SetVolumesFrom (Aws::Vector< VolumeFrom > &&value)
 
ContainerDefinitionWithVolumesFrom (const Aws::Vector< VolumeFrom > &value)
 
ContainerDefinitionWithVolumesFrom (Aws::Vector< VolumeFrom > &&value)
 
ContainerDefinitionAddVolumesFrom (const VolumeFrom &value)
 
ContainerDefinitionAddVolumesFrom (VolumeFrom &&value)
 
const LinuxParametersGetLinuxParameters () const
 
bool LinuxParametersHasBeenSet () const
 
void SetLinuxParameters (const LinuxParameters &value)
 
void SetLinuxParameters (LinuxParameters &&value)
 
ContainerDefinitionWithLinuxParameters (const LinuxParameters &value)
 
ContainerDefinitionWithLinuxParameters (LinuxParameters &&value)
 
const Aws::Vector< Secret > & GetSecrets () const
 
bool SecretsHasBeenSet () const
 
void SetSecrets (const Aws::Vector< Secret > &value)
 
void SetSecrets (Aws::Vector< Secret > &&value)
 
ContainerDefinitionWithSecrets (const Aws::Vector< Secret > &value)
 
ContainerDefinitionWithSecrets (Aws::Vector< Secret > &&value)
 
ContainerDefinitionAddSecrets (const Secret &value)
 
ContainerDefinitionAddSecrets (Secret &&value)
 
const Aws::Vector< ContainerDependency > & GetDependsOn () const
 
bool DependsOnHasBeenSet () const
 
void SetDependsOn (const Aws::Vector< ContainerDependency > &value)
 
void SetDependsOn (Aws::Vector< ContainerDependency > &&value)
 
ContainerDefinitionWithDependsOn (const Aws::Vector< ContainerDependency > &value)
 
ContainerDefinitionWithDependsOn (Aws::Vector< ContainerDependency > &&value)
 
ContainerDefinitionAddDependsOn (const ContainerDependency &value)
 
ContainerDefinitionAddDependsOn (ContainerDependency &&value)
 
int GetStartTimeout () const
 
bool StartTimeoutHasBeenSet () const
 
void SetStartTimeout (int value)
 
ContainerDefinitionWithStartTimeout (int value)
 
int GetStopTimeout () const
 
bool StopTimeoutHasBeenSet () const
 
void SetStopTimeout (int value)
 
ContainerDefinitionWithStopTimeout (int value)
 
const Aws::StringGetHostname () const
 
bool HostnameHasBeenSet () const
 
void SetHostname (const Aws::String &value)
 
void SetHostname (Aws::String &&value)
 
void SetHostname (const char *value)
 
ContainerDefinitionWithHostname (const Aws::String &value)
 
ContainerDefinitionWithHostname (Aws::String &&value)
 
ContainerDefinitionWithHostname (const char *value)
 
const Aws::StringGetUser () const
 
bool UserHasBeenSet () const
 
void SetUser (const Aws::String &value)
 
void SetUser (Aws::String &&value)
 
void SetUser (const char *value)
 
ContainerDefinitionWithUser (const Aws::String &value)
 
ContainerDefinitionWithUser (Aws::String &&value)
 
ContainerDefinitionWithUser (const char *value)
 
const Aws::StringGetWorkingDirectory () const
 
bool WorkingDirectoryHasBeenSet () const
 
void SetWorkingDirectory (const Aws::String &value)
 
void SetWorkingDirectory (Aws::String &&value)
 
void SetWorkingDirectory (const char *value)
 
ContainerDefinitionWithWorkingDirectory (const Aws::String &value)
 
ContainerDefinitionWithWorkingDirectory (Aws::String &&value)
 
ContainerDefinitionWithWorkingDirectory (const char *value)
 
bool GetDisableNetworking () const
 
bool DisableNetworkingHasBeenSet () const
 
void SetDisableNetworking (bool value)
 
ContainerDefinitionWithDisableNetworking (bool value)
 
bool GetPrivileged () const
 
bool PrivilegedHasBeenSet () const
 
void SetPrivileged (bool value)
 
ContainerDefinitionWithPrivileged (bool value)
 
bool GetReadonlyRootFilesystem () const
 
bool ReadonlyRootFilesystemHasBeenSet () const
 
void SetReadonlyRootFilesystem (bool value)
 
ContainerDefinitionWithReadonlyRootFilesystem (bool value)
 
const Aws::Vector< Aws::String > & GetDnsServers () const
 
bool DnsServersHasBeenSet () const
 
void SetDnsServers (const Aws::Vector< Aws::String > &value)
 
void SetDnsServers (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionWithDnsServers (const Aws::Vector< Aws::String > &value)
 
ContainerDefinitionWithDnsServers (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionAddDnsServers (const Aws::String &value)
 
ContainerDefinitionAddDnsServers (Aws::String &&value)
 
ContainerDefinitionAddDnsServers (const char *value)
 
const Aws::Vector< Aws::String > & GetDnsSearchDomains () const
 
bool DnsSearchDomainsHasBeenSet () const
 
void SetDnsSearchDomains (const Aws::Vector< Aws::String > &value)
 
void SetDnsSearchDomains (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionWithDnsSearchDomains (const Aws::Vector< Aws::String > &value)
 
ContainerDefinitionWithDnsSearchDomains (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionAddDnsSearchDomains (const Aws::String &value)
 
ContainerDefinitionAddDnsSearchDomains (Aws::String &&value)
 
ContainerDefinitionAddDnsSearchDomains (const char *value)
 
const Aws::Vector< HostEntry > & GetExtraHosts () const
 
bool ExtraHostsHasBeenSet () const
 
void SetExtraHosts (const Aws::Vector< HostEntry > &value)
 
void SetExtraHosts (Aws::Vector< HostEntry > &&value)
 
ContainerDefinitionWithExtraHosts (const Aws::Vector< HostEntry > &value)
 
ContainerDefinitionWithExtraHosts (Aws::Vector< HostEntry > &&value)
 
ContainerDefinitionAddExtraHosts (const HostEntry &value)
 
ContainerDefinitionAddExtraHosts (HostEntry &&value)
 
const Aws::Vector< Aws::String > & GetDockerSecurityOptions () const
 
bool DockerSecurityOptionsHasBeenSet () const
 
void SetDockerSecurityOptions (const Aws::Vector< Aws::String > &value)
 
void SetDockerSecurityOptions (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionWithDockerSecurityOptions (const Aws::Vector< Aws::String > &value)
 
ContainerDefinitionWithDockerSecurityOptions (Aws::Vector< Aws::String > &&value)
 
ContainerDefinitionAddDockerSecurityOptions (const Aws::String &value)
 
ContainerDefinitionAddDockerSecurityOptions (Aws::String &&value)
 
ContainerDefinitionAddDockerSecurityOptions (const char *value)
 
bool GetInteractive () const
 
bool InteractiveHasBeenSet () const
 
void SetInteractive (bool value)
 
ContainerDefinitionWithInteractive (bool value)
 
bool GetPseudoTerminal () const
 
bool PseudoTerminalHasBeenSet () const
 
void SetPseudoTerminal (bool value)
 
ContainerDefinitionWithPseudoTerminal (bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetDockerLabels () const
 
bool DockerLabelsHasBeenSet () const
 
void SetDockerLabels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetDockerLabels (Aws::Map< Aws::String, Aws::String > &&value)
 
ContainerDefinitionWithDockerLabels (const Aws::Map< Aws::String, Aws::String > &value)
 
ContainerDefinitionWithDockerLabels (Aws::Map< Aws::String, Aws::String > &&value)
 
ContainerDefinitionAddDockerLabels (const Aws::String &key, const Aws::String &value)
 
ContainerDefinitionAddDockerLabels (Aws::String &&key, const Aws::String &value)
 
ContainerDefinitionAddDockerLabels (const Aws::String &key, Aws::String &&value)
 
ContainerDefinitionAddDockerLabels (Aws::String &&key, Aws::String &&value)
 
ContainerDefinitionAddDockerLabels (const char *key, Aws::String &&value)
 
ContainerDefinitionAddDockerLabels (Aws::String &&key, const char *value)
 
ContainerDefinitionAddDockerLabels (const char *key, const char *value)
 
const Aws::Vector< Ulimit > & GetUlimits () const
 
bool UlimitsHasBeenSet () const
 
void SetUlimits (const Aws::Vector< Ulimit > &value)
 
void SetUlimits (Aws::Vector< Ulimit > &&value)
 
ContainerDefinitionWithUlimits (const Aws::Vector< Ulimit > &value)
 
ContainerDefinitionWithUlimits (Aws::Vector< Ulimit > &&value)
 
ContainerDefinitionAddUlimits (const Ulimit &value)
 
ContainerDefinitionAddUlimits (Ulimit &&value)
 
const LogConfigurationGetLogConfiguration () const
 
bool LogConfigurationHasBeenSet () const
 
void SetLogConfiguration (const LogConfiguration &value)
 
void SetLogConfiguration (LogConfiguration &&value)
 
ContainerDefinitionWithLogConfiguration (const LogConfiguration &value)
 
ContainerDefinitionWithLogConfiguration (LogConfiguration &&value)
 
const HealthCheckGetHealthCheck () const
 
bool HealthCheckHasBeenSet () const
 
void SetHealthCheck (const HealthCheck &value)
 
void SetHealthCheck (HealthCheck &&value)
 
ContainerDefinitionWithHealthCheck (const HealthCheck &value)
 
ContainerDefinitionWithHealthCheck (HealthCheck &&value)
 
const Aws::Vector< SystemControl > & GetSystemControls () const
 
bool SystemControlsHasBeenSet () const
 
void SetSystemControls (const Aws::Vector< SystemControl > &value)
 
void SetSystemControls (Aws::Vector< SystemControl > &&value)
 
ContainerDefinitionWithSystemControls (const Aws::Vector< SystemControl > &value)
 
ContainerDefinitionWithSystemControls (Aws::Vector< SystemControl > &&value)
 
ContainerDefinitionAddSystemControls (const SystemControl &value)
 
ContainerDefinitionAddSystemControls (SystemControl &&value)
 
const Aws::Vector< ResourceRequirement > & GetResourceRequirements () const
 
bool ResourceRequirementsHasBeenSet () const
 
void SetResourceRequirements (const Aws::Vector< ResourceRequirement > &value)
 
void SetResourceRequirements (Aws::Vector< ResourceRequirement > &&value)
 
ContainerDefinitionWithResourceRequirements (const Aws::Vector< ResourceRequirement > &value)
 
ContainerDefinitionWithResourceRequirements (Aws::Vector< ResourceRequirement > &&value)
 
ContainerDefinitionAddResourceRequirements (const ResourceRequirement &value)
 
ContainerDefinitionAddResourceRequirements (ResourceRequirement &&value)
 
const FirelensConfigurationGetFirelensConfiguration () const
 
bool FirelensConfigurationHasBeenSet () const
 
void SetFirelensConfiguration (const FirelensConfiguration &value)
 
void SetFirelensConfiguration (FirelensConfiguration &&value)
 
ContainerDefinitionWithFirelensConfiguration (const FirelensConfiguration &value)
 
ContainerDefinitionWithFirelensConfiguration (FirelensConfiguration &&value)
 

Detailed Description

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

See Also:

AWS API Reference

Definition at line 50 of file ContainerDefinition.h.

Constructor & Destructor Documentation

◆ ContainerDefinition() [1/2]

Aws::ECS::Model::ContainerDefinition::ContainerDefinition ( )

◆ ContainerDefinition() [2/2]

Aws::ECS::Model::ContainerDefinition::ContainerDefinition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCommand() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddCommand ( Aws::String &&  value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1645 of file ContainerDefinition.h.

◆ AddCommand() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddCommand ( const Aws::String value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1630 of file ContainerDefinition.h.

◆ AddCommand() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddCommand ( const char *  value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1660 of file ContainerDefinition.h.

◆ AddDependsOn() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDependsOn ( const ContainerDependency value)
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2415 of file ContainerDefinition.h.

◆ AddDependsOn() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDependsOn ( ContainerDependency &&  value)
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2437 of file ContainerDefinition.h.

◆ AddDnsSearchDomains() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDnsSearchDomains ( Aws::String &&  value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3420 of file ContainerDefinition.h.

◆ AddDnsSearchDomains() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDnsSearchDomains ( const Aws::String value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3407 of file ContainerDefinition.h.

◆ AddDnsSearchDomains() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDnsSearchDomains ( const char *  value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3433 of file ContainerDefinition.h.

◆ AddDnsServers() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDnsServers ( Aws::String &&  value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3302 of file ContainerDefinition.h.

◆ AddDnsServers() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDnsServers ( const Aws::String value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3289 of file ContainerDefinition.h.

◆ AddDnsServers() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDnsServers ( const char *  value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3315 of file ContainerDefinition.h.

◆ AddDockerLabels() [1/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4070 of file ContainerDefinition.h.

◆ AddDockerLabels() [2/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( Aws::String &&  key,
const Aws::String value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4040 of file ContainerDefinition.h.

◆ AddDockerLabels() [3/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( Aws::String &&  key,
const char *  value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4100 of file ContainerDefinition.h.

◆ AddDockerLabels() [4/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( const Aws::String key,
Aws::String &&  value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4055 of file ContainerDefinition.h.

◆ AddDockerLabels() [5/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( const Aws::String key,
const Aws::String value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4025 of file ContainerDefinition.h.

◆ AddDockerLabels() [6/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( const char *  key,
Aws::String &&  value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4085 of file ContainerDefinition.h.

◆ AddDockerLabels() [7/7]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerLabels ( const char *  key,
const char *  value 
)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4115 of file ContainerDefinition.h.

◆ AddDockerSecurityOptions() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerSecurityOptions ( Aws::String &&  value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3787 of file ContainerDefinition.h.

◆ AddDockerSecurityOptions() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerSecurityOptions ( const Aws::String value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3757 of file ContainerDefinition.h.

◆ AddDockerSecurityOptions() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddDockerSecurityOptions ( const char *  value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3817 of file ContainerDefinition.h.

◆ AddEntryPoint() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEntryPoint ( Aws::String &&  value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1507 of file ContainerDefinition.h.

◆ AddEntryPoint() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEntryPoint ( const Aws::String value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1490 of file ContainerDefinition.h.

◆ AddEntryPoint() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEntryPoint ( const char *  value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1524 of file ContainerDefinition.h.

◆ AddEnvironment() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEnvironment ( const KeyValuePair value)
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1752 of file ContainerDefinition.h.

◆ AddEnvironment() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEnvironment ( KeyValuePair &&  value)
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1765 of file ContainerDefinition.h.

◆ AddEnvironmentFiles() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEnvironmentFiles ( const EnvironmentFile value)
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1920 of file ContainerDefinition.h.

◆ AddEnvironmentFiles() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddEnvironmentFiles ( EnvironmentFile &&  value)
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1942 of file ContainerDefinition.h.

◆ AddExtraHosts() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddExtraHosts ( const HostEntry value)
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3532 of file ContainerDefinition.h.

◆ AddExtraHosts() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddExtraHosts ( HostEntry &&  value)
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3546 of file ContainerDefinition.h.

◆ AddLinks() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddLinks ( Aws::String &&  value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 1053 of file ContainerDefinition.h.

◆ AddLinks() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddLinks ( const Aws::String value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 1030 of file ContainerDefinition.h.

◆ AddLinks() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddLinks ( const char *  value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 1076 of file ContainerDefinition.h.

◆ AddMountPoints() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddMountPoints ( const MountPoint value)
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 2041 of file ContainerDefinition.h.

◆ AddMountPoints() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddMountPoints ( MountPoint &&  value)
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 2055 of file ContainerDefinition.h.

◆ AddPortMappings() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddPortMappings ( const PortMapping value)
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1273 of file ContainerDefinition.h.

◆ AddPortMappings() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddPortMappings ( PortMapping &&  value)
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1301 of file ContainerDefinition.h.

◆ AddResourceRequirements() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddResourceRequirements ( const ResourceRequirement value)
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4788 of file ContainerDefinition.h.

◆ AddResourceRequirements() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddResourceRequirements ( ResourceRequirement &&  value)
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4794 of file ContainerDefinition.h.

◆ AddSecrets() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddSecrets ( const Secret value)
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2252 of file ContainerDefinition.h.

◆ AddSecrets() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddSecrets ( Secret &&  value)
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2260 of file ContainerDefinition.h.

◆ AddSystemControls() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddSystemControls ( const SystemControl value)
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4726 of file ContainerDefinition.h.

◆ AddSystemControls() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddSystemControls ( SystemControl &&  value)
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4745 of file ContainerDefinition.h.

◆ AddUlimits() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddUlimits ( const Ulimit value)
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4284 of file ContainerDefinition.h.

◆ AddUlimits() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddUlimits ( Ulimit &&  value)
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4308 of file ContainerDefinition.h.

◆ AddVolumesFrom() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddVolumesFrom ( const VolumeFrom value)
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2140 of file ContainerDefinition.h.

◆ AddVolumesFrom() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::AddVolumesFrom ( VolumeFrom &&  value)
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2152 of file ContainerDefinition.h.

◆ CommandHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::CommandHasBeenSet ( ) const
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1555 of file ContainerDefinition.h.

◆ CpuHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::CpuHasBeenSet ( ) const
inline

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

Definition at line 556 of file ContainerDefinition.h.

◆ DependsOnHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::DependsOnHasBeenSet ( ) const
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2305 of file ContainerDefinition.h.

◆ DisableNetworkingHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::DisableNetworkingHasBeenSet ( ) const
inline

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

Definition at line 3067 of file ContainerDefinition.h.

◆ DnsSearchDomainsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::DnsSearchDomainsHasBeenSet ( ) const
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3342 of file ContainerDefinition.h.

◆ DnsServersHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::DnsServersHasBeenSet ( ) const
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3224 of file ContainerDefinition.h.

◆ DockerLabelsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::DockerLabelsHasBeenSet ( ) const
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 3950 of file ContainerDefinition.h.

◆ DockerSecurityOptionsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::DockerSecurityOptionsHasBeenSet ( ) const
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3607 of file ContainerDefinition.h.

◆ EntryPointHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::EntryPointHasBeenSet ( ) const
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1405 of file ContainerDefinition.h.

◆ EnvironmentFilesHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::EnvironmentFilesHasBeenSet ( ) const
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1810 of file ContainerDefinition.h.

◆ EnvironmentHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::EnvironmentHasBeenSet ( ) const
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1687 of file ContainerDefinition.h.

◆ EssentialHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::EssentialHasBeenSet ( ) const
inline

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

Definition at line 1336 of file ContainerDefinition.h.

◆ ExtraHostsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::ExtraHostsHasBeenSet ( ) const
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3462 of file ContainerDefinition.h.

◆ FirelensConfigurationHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::FirelensConfigurationHasBeenSet ( ) const
inline

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Definition at line 4813 of file ContainerDefinition.h.

◆ GetCommand()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerDefinition::GetCommand ( ) const
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1540 of file ContainerDefinition.h.

◆ GetCpu()

int Aws::ECS::Model::ContainerDefinition::GetCpu ( ) const
inline

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

Definition at line 511 of file ContainerDefinition.h.

◆ GetDependsOn()

const Aws::Vector<ContainerDependency>& Aws::ECS::Model::ContainerDefinition::GetDependsOn ( ) const
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2283 of file ContainerDefinition.h.

◆ GetDisableNetworking()

bool Aws::ECS::Model::ContainerDefinition::GetDisableNetworking ( ) const
inline

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

Definition at line 3057 of file ContainerDefinition.h.

◆ GetDnsSearchDomains()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerDefinition::GetDnsSearchDomains ( ) const
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3329 of file ContainerDefinition.h.

◆ GetDnsServers()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerDefinition::GetDnsServers ( ) const
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3211 of file ContainerDefinition.h.

◆ GetDockerLabels()

const Aws::Map<Aws::String, Aws::String>& Aws::ECS::Model::ContainerDefinition::GetDockerLabels ( ) const
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 3935 of file ContainerDefinition.h.

◆ GetDockerSecurityOptions()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerDefinition::GetDockerSecurityOptions ( ) const
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3577 of file ContainerDefinition.h.

◆ GetEntryPoint()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerDefinition::GetEntryPoint ( ) const
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1388 of file ContainerDefinition.h.

◆ GetEnvironment()

const Aws::Vector<KeyValuePair>& Aws::ECS::Model::ContainerDefinition::GetEnvironment ( ) const
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1674 of file ContainerDefinition.h.

◆ GetEnvironmentFiles()

const Aws::Vector<EnvironmentFile>& Aws::ECS::Model::ContainerDefinition::GetEnvironmentFiles ( ) const
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1788 of file ContainerDefinition.h.

◆ GetEssential()

bool Aws::ECS::Model::ContainerDefinition::GetEssential ( ) const
inline

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

Definition at line 1319 of file ContainerDefinition.h.

◆ GetExtraHosts()

const Aws::Vector<HostEntry>& Aws::ECS::Model::ContainerDefinition::GetExtraHosts ( ) const
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3448 of file ContainerDefinition.h.

◆ GetFirelensConfiguration()

const FirelensConfiguration& Aws::ECS::Model::ContainerDefinition::GetFirelensConfiguration ( ) const
inline

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Definition at line 4804 of file ContainerDefinition.h.

◆ GetHealthCheck()

const HealthCheck& Aws::ECS::Model::ContainerDefinition::GetHealthCheck ( ) const
inline

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

Definition at line 4532 of file ContainerDefinition.h.

◆ GetHostname()

const Aws::String& Aws::ECS::Model::ContainerDefinition::GetHostname ( ) const
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2689 of file ContainerDefinition.h.

◆ GetImage()

const Aws::String& Aws::ECS::Model::ContainerDefinition::GetImage ( ) const
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 210 of file ContainerDefinition.h.

◆ GetInteractive()

bool Aws::ECS::Model::ContainerDefinition::GetInteractive ( ) const
inline

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the –interactive option to docker run.

Definition at line 3831 of file ContainerDefinition.h.

◆ GetLinks()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerDefinition::GetLinks ( ) const
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 892 of file ContainerDefinition.h.

◆ GetLinuxParameters()

const LinuxParameters& Aws::ECS::Model::ContainerDefinition::GetLinuxParameters ( ) const
inline

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

Definition at line 2160 of file ContainerDefinition.h.

◆ GetLogConfiguration()

const LogConfiguration& Aws::ECS::Model::ContainerDefinition::GetLogConfiguration ( ) const
inline

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Definition at line 4344 of file ContainerDefinition.h.

◆ GetMemory()

int Aws::ECS::Model::ContainerDefinition::GetMemory ( ) const
inline

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 671 of file ContainerDefinition.h.

◆ GetMemoryReservation()

int Aws::ECS::Model::ContainerDefinition::GetMemoryReservation ( ) const
inline

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the –memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 775 of file ContainerDefinition.h.

◆ GetMountPoints()

const Aws::Vector<MountPoint>& Aws::ECS::Model::ContainerDefinition::GetMountPoints ( ) const
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 1957 of file ContainerDefinition.h.

◆ GetName()

const Aws::String& Aws::ECS::Model::ContainerDefinition::GetName ( ) const
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 72 of file ContainerDefinition.h.

◆ GetPortMappings()

const Aws::Vector<PortMapping>& Aws::ECS::Model::ContainerDefinition::GetPortMappings ( ) const
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1105 of file ContainerDefinition.h.

◆ GetPrivileged()

bool Aws::ECS::Model::ContainerDefinition::GetPrivileged ( ) const
inline

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on AWS Fargate.

Definition at line 3102 of file ContainerDefinition.h.

◆ GetPseudoTerminal()

bool Aws::ECS::Model::ContainerDefinition::GetPseudoTerminal ( ) const
inline

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the –tty option to docker run.

Definition at line 3883 of file ContainerDefinition.h.

◆ GetReadonlyRootFilesystem()

bool Aws::ECS::Model::ContainerDefinition::GetReadonlyRootFilesystem ( ) const
inline

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3158 of file ContainerDefinition.h.

◆ GetRepositoryCredentials()

const RepositoryCredentials& Aws::ECS::Model::ContainerDefinition::GetRepositoryCredentials ( ) const
inline

The private repository authentication credentials to use.

Definition at line 440 of file ContainerDefinition.h.

◆ GetResourceRequirements()

const Aws::Vector<ResourceRequirement>& Aws::ECS::Model::ContainerDefinition::GetResourceRequirements ( ) const
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4752 of file ContainerDefinition.h.

◆ GetSecrets()

const Aws::Vector<Secret>& Aws::ECS::Model::ContainerDefinition::GetSecrets ( ) const
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2204 of file ContainerDefinition.h.

◆ GetStartTimeout()

int Aws::ECS::Model::ContainerDefinition::GetStartTimeout ( ) const
inline

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it is enforced indendently from this start timeout value.

For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2468 of file ContainerDefinition.h.

◆ GetStopTimeout()

int Aws::ECS::Model::ContainerDefinition::GetStopTimeout ( ) const
inline

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2588 of file ContainerDefinition.h.

◆ GetSystemControls()

const Aws::Vector<SystemControl>& Aws::ECS::Model::ContainerDefinition::GetSystemControls ( ) const
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4612 of file ContainerDefinition.h.

◆ GetUlimits()

const Aws::Vector<Ulimit>& Aws::ECS::Model::ContainerDefinition::GetUlimits ( ) const
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4140 of file ContainerDefinition.h.

◆ GetUser()

const Aws::String& Aws::ECS::Model::ContainerDefinition::GetUser ( ) const
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2802 of file ContainerDefinition.h.

◆ GetVolumesFrom()

const Aws::Vector<VolumeFrom>& Aws::ECS::Model::ContainerDefinition::GetVolumesFrom ( ) const
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2068 of file ContainerDefinition.h.

◆ GetWorkingDirectory()

const Aws::String& Aws::ECS::Model::ContainerDefinition::GetWorkingDirectory ( ) const
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 2962 of file ContainerDefinition.h.

◆ HealthCheckHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::HealthCheckHasBeenSet ( ) const
inline

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

Definition at line 4544 of file ContainerDefinition.h.

◆ HostnameHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::HostnameHasBeenSet ( ) const
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2702 of file ContainerDefinition.h.

◆ ImageHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::ImageHasBeenSet ( ) const
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 242 of file ContainerDefinition.h.

◆ InteractiveHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::InteractiveHasBeenSet ( ) const
inline

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the –interactive option to docker run.

Definition at line 3844 of file ContainerDefinition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::ContainerDefinition::Jsonize ( ) const

◆ LinksHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::LinksHasBeenSet ( ) const
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 915 of file ContainerDefinition.h.

◆ LinuxParametersHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::LinuxParametersHasBeenSet ( ) const
inline

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

Definition at line 2167 of file ContainerDefinition.h.

◆ LogConfigurationHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::LogConfigurationHasBeenSet ( ) const
inline

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Definition at line 4379 of file ContainerDefinition.h.

◆ MemoryHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::MemoryHasBeenSet ( ) const
inline

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 695 of file ContainerDefinition.h.

◆ MemoryReservationHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::MemoryReservationHasBeenSet ( ) const
inline

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the –memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 806 of file ContainerDefinition.h.

◆ MountPointsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::MountPointsHasBeenSet ( ) const
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 1971 of file ContainerDefinition.h.

◆ NameHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::NameHasBeenSet ( ) const
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 87 of file ContainerDefinition.h.

◆ operator=()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PortMappingsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::PortMappingsHasBeenSet ( ) const
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1133 of file ContainerDefinition.h.

◆ PrivilegedHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::PrivilegedHasBeenSet ( ) const
inline

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on AWS Fargate.

Definition at line 3116 of file ContainerDefinition.h.

◆ PseudoTerminalHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::PseudoTerminalHasBeenSet ( ) const
inline

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the –tty option to docker run.

Definition at line 3895 of file ContainerDefinition.h.

◆ ReadonlyRootFilesystemHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::ReadonlyRootFilesystemHasBeenSet ( ) const
inline

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3171 of file ContainerDefinition.h.

◆ RepositoryCredentialsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::RepositoryCredentialsHasBeenSet ( ) const
inline

The private repository authentication credentials to use.

Definition at line 445 of file ContainerDefinition.h.

◆ ResourceRequirementsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::ResourceRequirementsHasBeenSet ( ) const
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4758 of file ContainerDefinition.h.

◆ SecretsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::SecretsHasBeenSet ( ) const
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2212 of file ContainerDefinition.h.

◆ SetCommand() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetCommand ( Aws::Vector< Aws::String > &&  value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1585 of file ContainerDefinition.h.

◆ SetCommand() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetCommand ( const Aws::Vector< Aws::String > &  value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1570 of file ContainerDefinition.h.

◆ SetCpu()

void Aws::ECS::Model::ContainerDefinition::SetCpu ( int  value)
inline

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

Definition at line 601 of file ContainerDefinition.h.

◆ SetDependsOn() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetDependsOn ( Aws::Vector< ContainerDependency > &&  value)
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2349 of file ContainerDefinition.h.

◆ SetDependsOn() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetDependsOn ( const Aws::Vector< ContainerDependency > &  value)
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2327 of file ContainerDefinition.h.

◆ SetDisableNetworking()

void Aws::ECS::Model::ContainerDefinition::SetDisableNetworking ( bool  value)
inline

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

Definition at line 3077 of file ContainerDefinition.h.

◆ SetDnsSearchDomains() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetDnsSearchDomains ( Aws::Vector< Aws::String > &&  value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3368 of file ContainerDefinition.h.

◆ SetDnsSearchDomains() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetDnsSearchDomains ( const Aws::Vector< Aws::String > &  value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3355 of file ContainerDefinition.h.

◆ SetDnsServers() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetDnsServers ( Aws::Vector< Aws::String > &&  value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3250 of file ContainerDefinition.h.

◆ SetDnsServers() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetDnsServers ( const Aws::Vector< Aws::String > &  value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3237 of file ContainerDefinition.h.

◆ SetDockerLabels() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetDockerLabels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 3980 of file ContainerDefinition.h.

◆ SetDockerLabels() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetDockerLabels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 3965 of file ContainerDefinition.h.

◆ SetDockerSecurityOptions() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetDockerSecurityOptions ( Aws::Vector< Aws::String > &&  value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3667 of file ContainerDefinition.h.

◆ SetDockerSecurityOptions() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetDockerSecurityOptions ( const Aws::Vector< Aws::String > &  value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3637 of file ContainerDefinition.h.

◆ SetEntryPoint() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetEntryPoint ( Aws::Vector< Aws::String > &&  value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1439 of file ContainerDefinition.h.

◆ SetEntryPoint() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetEntryPoint ( const Aws::Vector< Aws::String > &  value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1422 of file ContainerDefinition.h.

◆ SetEnvironment() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetEnvironment ( Aws::Vector< KeyValuePair > &&  value)
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1713 of file ContainerDefinition.h.

◆ SetEnvironment() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetEnvironment ( const Aws::Vector< KeyValuePair > &  value)
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1700 of file ContainerDefinition.h.

◆ SetEnvironmentFiles() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetEnvironmentFiles ( Aws::Vector< EnvironmentFile > &&  value)
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1854 of file ContainerDefinition.h.

◆ SetEnvironmentFiles() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetEnvironmentFiles ( const Aws::Vector< EnvironmentFile > &  value)
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1832 of file ContainerDefinition.h.

◆ SetEssential()

void Aws::ECS::Model::ContainerDefinition::SetEssential ( bool  value)
inline

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

Definition at line 1353 of file ContainerDefinition.h.

◆ SetExtraHosts() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetExtraHosts ( Aws::Vector< HostEntry > &&  value)
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3490 of file ContainerDefinition.h.

◆ SetExtraHosts() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetExtraHosts ( const Aws::Vector< HostEntry > &  value)
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3476 of file ContainerDefinition.h.

◆ SetFirelensConfiguration() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetFirelensConfiguration ( const FirelensConfiguration value)
inline

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Definition at line 4822 of file ContainerDefinition.h.

◆ SetFirelensConfiguration() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetFirelensConfiguration ( FirelensConfiguration &&  value)
inline

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Definition at line 4831 of file ContainerDefinition.h.

◆ SetHealthCheck() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetHealthCheck ( const HealthCheck value)
inline

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

Definition at line 4556 of file ContainerDefinition.h.

◆ SetHealthCheck() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetHealthCheck ( HealthCheck &&  value)
inline

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

Definition at line 4568 of file ContainerDefinition.h.

◆ SetHostname() [1/3]

void Aws::ECS::Model::ContainerDefinition::SetHostname ( Aws::String &&  value)
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2728 of file ContainerDefinition.h.

◆ SetHostname() [2/3]

void Aws::ECS::Model::ContainerDefinition::SetHostname ( const Aws::String value)
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2715 of file ContainerDefinition.h.

◆ SetHostname() [3/3]

void Aws::ECS::Model::ContainerDefinition::SetHostname ( const char *  value)
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2741 of file ContainerDefinition.h.

◆ SetImage() [1/3]

void Aws::ECS::Model::ContainerDefinition::SetImage ( Aws::String &&  value)
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 306 of file ContainerDefinition.h.

◆ SetImage() [2/3]

void Aws::ECS::Model::ContainerDefinition::SetImage ( const Aws::String value)
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 274 of file ContainerDefinition.h.

◆ SetImage() [3/3]

void Aws::ECS::Model::ContainerDefinition::SetImage ( const char *  value)
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 338 of file ContainerDefinition.h.

◆ SetInteractive()

void Aws::ECS::Model::ContainerDefinition::SetInteractive ( bool  value)
inline

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the –interactive option to docker run.

Definition at line 3857 of file ContainerDefinition.h.

◆ SetLinks() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetLinks ( Aws::Vector< Aws::String > &&  value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 961 of file ContainerDefinition.h.

◆ SetLinks() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetLinks ( const Aws::Vector< Aws::String > &  value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 938 of file ContainerDefinition.h.

◆ SetLinuxParameters() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetLinuxParameters ( const LinuxParameters value)
inline

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

Definition at line 2174 of file ContainerDefinition.h.

◆ SetLinuxParameters() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetLinuxParameters ( LinuxParameters &&  value)
inline

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

Definition at line 2181 of file ContainerDefinition.h.

◆ SetLogConfiguration() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetLogConfiguration ( const LogConfiguration value)
inline

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Definition at line 4414 of file ContainerDefinition.h.

◆ SetLogConfiguration() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetLogConfiguration ( LogConfiguration &&  value)
inline

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Definition at line 4449 of file ContainerDefinition.h.

◆ SetMemory()

void Aws::ECS::Model::ContainerDefinition::SetMemory ( int  value)
inline

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 719 of file ContainerDefinition.h.

◆ SetMemoryReservation()

void Aws::ECS::Model::ContainerDefinition::SetMemoryReservation ( int  value)
inline

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the –memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 837 of file ContainerDefinition.h.

◆ SetMountPoints() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetMountPoints ( Aws::Vector< MountPoint > &&  value)
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 1999 of file ContainerDefinition.h.

◆ SetMountPoints() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetMountPoints ( const Aws::Vector< MountPoint > &  value)
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 1985 of file ContainerDefinition.h.

◆ SetName() [1/3]

void Aws::ECS::Model::ContainerDefinition::SetName ( Aws::String &&  value)
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 117 of file ContainerDefinition.h.

◆ SetName() [2/3]

void Aws::ECS::Model::ContainerDefinition::SetName ( const Aws::String value)
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 102 of file ContainerDefinition.h.

◆ SetName() [3/3]

void Aws::ECS::Model::ContainerDefinition::SetName ( const char *  value)
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 132 of file ContainerDefinition.h.

◆ SetPortMappings() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetPortMappings ( Aws::Vector< PortMapping > &&  value)
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1189 of file ContainerDefinition.h.

◆ SetPortMappings() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetPortMappings ( const Aws::Vector< PortMapping > &  value)
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1161 of file ContainerDefinition.h.

◆ SetPrivileged()

void Aws::ECS::Model::ContainerDefinition::SetPrivileged ( bool  value)
inline

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on AWS Fargate.

Definition at line 3130 of file ContainerDefinition.h.

◆ SetPseudoTerminal()

void Aws::ECS::Model::ContainerDefinition::SetPseudoTerminal ( bool  value)
inline

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the –tty option to docker run.

Definition at line 3907 of file ContainerDefinition.h.

◆ SetReadonlyRootFilesystem()

void Aws::ECS::Model::ContainerDefinition::SetReadonlyRootFilesystem ( bool  value)
inline

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3184 of file ContainerDefinition.h.

◆ SetRepositoryCredentials() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetRepositoryCredentials ( const RepositoryCredentials value)
inline

The private repository authentication credentials to use.

Definition at line 450 of file ContainerDefinition.h.

◆ SetRepositoryCredentials() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetRepositoryCredentials ( RepositoryCredentials &&  value)
inline

The private repository authentication credentials to use.

Definition at line 455 of file ContainerDefinition.h.

◆ SetResourceRequirements() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetResourceRequirements ( Aws::Vector< ResourceRequirement > &&  value)
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4770 of file ContainerDefinition.h.

◆ SetResourceRequirements() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetResourceRequirements ( const Aws::Vector< ResourceRequirement > &  value)
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4764 of file ContainerDefinition.h.

◆ SetSecrets() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetSecrets ( Aws::Vector< Secret > &&  value)
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2228 of file ContainerDefinition.h.

◆ SetSecrets() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetSecrets ( const Aws::Vector< Secret > &  value)
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2220 of file ContainerDefinition.h.

◆ SetStartTimeout()

void Aws::ECS::Model::ContainerDefinition::SetStartTimeout ( int  value)
inline

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it is enforced indendently from this start timeout value.

For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2528 of file ContainerDefinition.h.

◆ SetStopTimeout()

void Aws::ECS::Model::ContainerDefinition::SetStopTimeout ( int  value)
inline

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2646 of file ContainerDefinition.h.

◆ SetSystemControls() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetSystemControls ( Aws::Vector< SystemControl > &&  value)
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4669 of file ContainerDefinition.h.

◆ SetSystemControls() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetSystemControls ( const Aws::Vector< SystemControl > &  value)
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4650 of file ContainerDefinition.h.

◆ SetUlimits() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetUlimits ( Aws::Vector< Ulimit > &&  value)
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4212 of file ContainerDefinition.h.

◆ SetUlimits() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetUlimits ( const Aws::Vector< Ulimit > &  value)
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4188 of file ContainerDefinition.h.

◆ SetUser() [1/3]

void Aws::ECS::Model::ContainerDefinition::SetUser ( Aws::String &&  value)
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2865 of file ContainerDefinition.h.

◆ SetUser() [2/3]

void Aws::ECS::Model::ContainerDefinition::SetUser ( const Aws::String value)
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2844 of file ContainerDefinition.h.

◆ SetUser() [3/3]

void Aws::ECS::Model::ContainerDefinition::SetUser ( const char *  value)
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2886 of file ContainerDefinition.h.

◆ SetVolumesFrom() [1/2]

void Aws::ECS::Model::ContainerDefinition::SetVolumesFrom ( Aws::Vector< VolumeFrom > &&  value)
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2104 of file ContainerDefinition.h.

◆ SetVolumesFrom() [2/2]

void Aws::ECS::Model::ContainerDefinition::SetVolumesFrom ( const Aws::Vector< VolumeFrom > &  value)
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2092 of file ContainerDefinition.h.

◆ SetWorkingDirectory() [1/3]

void Aws::ECS::Model::ContainerDefinition::SetWorkingDirectory ( Aws::String &&  value)
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 2998 of file ContainerDefinition.h.

◆ SetWorkingDirectory() [2/3]

void Aws::ECS::Model::ContainerDefinition::SetWorkingDirectory ( const Aws::String value)
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 2986 of file ContainerDefinition.h.

◆ SetWorkingDirectory() [3/3]

void Aws::ECS::Model::ContainerDefinition::SetWorkingDirectory ( const char *  value)
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 3010 of file ContainerDefinition.h.

◆ StartTimeoutHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::StartTimeoutHasBeenSet ( ) const
inline

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it is enforced indendently from this start timeout value.

For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2498 of file ContainerDefinition.h.

◆ StopTimeoutHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::StopTimeoutHasBeenSet ( ) const
inline

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2617 of file ContainerDefinition.h.

◆ SystemControlsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::SystemControlsHasBeenSet ( ) const
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4631 of file ContainerDefinition.h.

◆ UlimitsHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::UlimitsHasBeenSet ( ) const
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4164 of file ContainerDefinition.h.

◆ UserHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::UserHasBeenSet ( ) const
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2823 of file ContainerDefinition.h.

◆ VolumesFromHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::VolumesFromHasBeenSet ( ) const
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2080 of file ContainerDefinition.h.

◆ WithCommand() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithCommand ( Aws::Vector< Aws::String > &&  value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1615 of file ContainerDefinition.h.

◆ WithCommand() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithCommand ( const Aws::Vector< Aws::String > &  value)
inline

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

Definition at line 1600 of file ContainerDefinition.h.

◆ WithCpu()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithCpu ( int  value)
inline

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

Definition at line 646 of file ContainerDefinition.h.

◆ WithDependsOn() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDependsOn ( Aws::Vector< ContainerDependency > &&  value)
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2393 of file ContainerDefinition.h.

◆ WithDependsOn() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDependsOn ( const Aws::Vector< ContainerDependency > &  value)
inline

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

Definition at line 2371 of file ContainerDefinition.h.

◆ WithDisableNetworking()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDisableNetworking ( bool  value)
inline

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

Definition at line 3087 of file ContainerDefinition.h.

◆ WithDnsSearchDomains() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDnsSearchDomains ( Aws::Vector< Aws::String > &&  value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3394 of file ContainerDefinition.h.

◆ WithDnsSearchDomains() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDnsSearchDomains ( const Aws::Vector< Aws::String > &  value)
inline

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the –dns-search option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3381 of file ContainerDefinition.h.

◆ WithDnsServers() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDnsServers ( Aws::Vector< Aws::String > &&  value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3276 of file ContainerDefinition.h.

◆ WithDnsServers() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDnsServers ( const Aws::Vector< Aws::String > &  value)
inline

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the –dns option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3263 of file ContainerDefinition.h.

◆ WithDockerLabels() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDockerLabels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 4010 of file ContainerDefinition.h.

◆ WithDockerLabels() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDockerLabels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the –label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

Definition at line 3995 of file ContainerDefinition.h.

◆ WithDockerSecurityOptions() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDockerSecurityOptions ( Aws::Vector< Aws::String > &&  value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3727 of file ContainerDefinition.h.

◆ WithDockerSecurityOptions() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithDockerSecurityOptions ( const Aws::Vector< Aws::String > &  value)
inline

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the –security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Definition at line 3697 of file ContainerDefinition.h.

◆ WithEntryPoint() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEntryPoint ( Aws::Vector< Aws::String > &&  value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1473 of file ContainerDefinition.h.

◆ WithEntryPoint() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEntryPoint ( const Aws::Vector< Aws::String > &  value)
inline

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the –entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Definition at line 1456 of file ContainerDefinition.h.

◆ WithEnvironment() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEnvironment ( Aws::Vector< KeyValuePair > &&  value)
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1739 of file ContainerDefinition.h.

◆ WithEnvironment() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEnvironment ( const Aws::Vector< KeyValuePair > &  value)
inline

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Definition at line 1726 of file ContainerDefinition.h.

◆ WithEnvironmentFiles() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEnvironmentFiles ( Aws::Vector< EnvironmentFile > &&  value)
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1898 of file ContainerDefinition.h.

◆ WithEnvironmentFiles() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEnvironmentFiles ( const Aws::Vector< EnvironmentFile > &  value)
inline

A list of files containing the environment variables to pass to a container. This parameter maps to the –env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

Definition at line 1876 of file ContainerDefinition.h.

◆ WithEssential()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithEssential ( bool  value)
inline

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

Definition at line 1370 of file ContainerDefinition.h.

◆ WithExtraHosts() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithExtraHosts ( Aws::Vector< HostEntry > &&  value)
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3518 of file ContainerDefinition.h.

◆ WithExtraHosts() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithExtraHosts ( const Aws::Vector< HostEntry > &  value)
inline

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the –add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

Definition at line 3504 of file ContainerDefinition.h.

◆ WithFirelensConfiguration() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithFirelensConfiguration ( const FirelensConfiguration value)
inline

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Definition at line 4840 of file ContainerDefinition.h.

◆ WithFirelensConfiguration() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithFirelensConfiguration ( FirelensConfiguration &&  value)
inline

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Definition at line 4849 of file ContainerDefinition.h.

◆ WithHealthCheck() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithHealthCheck ( const HealthCheck value)
inline

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

Definition at line 4580 of file ContainerDefinition.h.

◆ WithHealthCheck() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithHealthCheck ( HealthCheck &&  value)
inline

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

Definition at line 4592 of file ContainerDefinition.h.

◆ WithHostname() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithHostname ( Aws::String &&  value)
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2767 of file ContainerDefinition.h.

◆ WithHostname() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithHostname ( const Aws::String value)
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2754 of file ContainerDefinition.h.

◆ WithHostname() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithHostname ( const char *  value)
inline

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the –hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

Definition at line 2780 of file ContainerDefinition.h.

◆ WithImage() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithImage ( Aws::String &&  value)
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 402 of file ContainerDefinition.h.

◆ WithImage() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithImage ( const Aws::String value)
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 370 of file ContainerDefinition.h.

◆ WithImage() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithImage ( const char *  value)
inline

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image<i>digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Definition at line 434 of file ContainerDefinition.h.

◆ WithInteractive()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithInteractive ( bool  value)
inline

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the –interactive option to docker run.

Definition at line 3870 of file ContainerDefinition.h.

◆ WithLinks() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithLinks ( Aws::Vector< Aws::String > &&  value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 1007 of file ContainerDefinition.h.

◆ WithLinks() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithLinks ( const Aws::Vector< Aws::String > &  value)
inline

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the –link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Definition at line 984 of file ContainerDefinition.h.

◆ WithLinuxParameters() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithLinuxParameters ( const LinuxParameters value)
inline

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

Definition at line 2188 of file ContainerDefinition.h.

◆ WithLinuxParameters() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithLinuxParameters ( LinuxParameters &&  value)
inline

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

Definition at line 2195 of file ContainerDefinition.h.

◆ WithLogConfiguration() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithLogConfiguration ( const LogConfiguration value)
inline

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Definition at line 4484 of file ContainerDefinition.h.

◆ WithLogConfiguration() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithLogConfiguration ( LogConfiguration &&  value)
inline

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Definition at line 4519 of file ContainerDefinition.h.

◆ WithMemory()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithMemory ( int  value)
inline

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 743 of file ContainerDefinition.h.

◆ WithMemoryReservation()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithMemoryReservation ( int  value)
inline

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the –memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Definition at line 868 of file ContainerDefinition.h.

◆ WithMountPoints() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithMountPoints ( Aws::Vector< MountPoint > &&  value)
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 2027 of file ContainerDefinition.h.

◆ WithMountPoints() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithMountPoints ( const Aws::Vector< MountPoint > &  value)
inline

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

Definition at line 2013 of file ContainerDefinition.h.

◆ WithName() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithName ( Aws::String &&  value)
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 162 of file ContainerDefinition.h.

◆ WithName() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithName ( const Aws::String value)
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 147 of file ContainerDefinition.h.

◆ WithName() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithName ( const char *  value)
inline

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the –name option to docker run.

Definition at line 177 of file ContainerDefinition.h.

◆ WithPortMappings() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithPortMappings ( Aws::Vector< PortMapping > &&  value)
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1245 of file ContainerDefinition.h.

◆ WithPortMappings() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithPortMappings ( const Aws::Vector< PortMapping > &  value)
inline

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the –publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

Definition at line 1217 of file ContainerDefinition.h.

◆ WithPrivileged()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithPrivileged ( bool  value)
inline

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on AWS Fargate.

Definition at line 3144 of file ContainerDefinition.h.

◆ WithPseudoTerminal()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithPseudoTerminal ( bool  value)
inline

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the –tty option to docker run.

Definition at line 3919 of file ContainerDefinition.h.

◆ WithReadonlyRootFilesystem()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithReadonlyRootFilesystem ( bool  value)
inline

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.

This parameter is not supported for Windows containers.

Definition at line 3197 of file ContainerDefinition.h.

◆ WithRepositoryCredentials() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithRepositoryCredentials ( const RepositoryCredentials value)
inline

The private repository authentication credentials to use.

Definition at line 460 of file ContainerDefinition.h.

◆ WithRepositoryCredentials() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithRepositoryCredentials ( RepositoryCredentials &&  value)
inline

The private repository authentication credentials to use.

Definition at line 465 of file ContainerDefinition.h.

◆ WithResourceRequirements() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithResourceRequirements ( Aws::Vector< ResourceRequirement > &&  value)
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4782 of file ContainerDefinition.h.

◆ WithResourceRequirements() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithResourceRequirements ( const Aws::Vector< ResourceRequirement > &  value)
inline

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Definition at line 4776 of file ContainerDefinition.h.

◆ WithSecrets() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithSecrets ( Aws::Vector< Secret > &&  value)
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2244 of file ContainerDefinition.h.

◆ WithSecrets() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithSecrets ( const Aws::Vector< Secret > &  value)
inline

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Definition at line 2236 of file ContainerDefinition.h.

◆ WithStartTimeout()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithStartTimeout ( int  value)
inline

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it is enforced indendently from this start timeout value.

For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2558 of file ContainerDefinition.h.

◆ WithStopTimeout()

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithStopTimeout ( int  value)
inline

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

Definition at line 2675 of file ContainerDefinition.h.

◆ WithSystemControls() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithSystemControls ( Aws::Vector< SystemControl > &&  value)
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4707 of file ContainerDefinition.h.

◆ WithSystemControls() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithSystemControls ( const Aws::Vector< SystemControl > &  value)
inline

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

Definition at line 4688 of file ContainerDefinition.h.

◆ WithUlimits() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithUlimits ( Aws::Vector< Ulimit > &&  value)
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4260 of file ContainerDefinition.h.

◆ WithUlimits() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithUlimits ( const Aws::Vector< Ulimit > &  value)
inline

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Definition at line 4236 of file ContainerDefinition.h.

◆ WithUser() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithUser ( Aws::String &&  value)
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2928 of file ContainerDefinition.h.

◆ WithUser() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithUser ( const Aws::String value)
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2907 of file ContainerDefinition.h.

◆ WithUser() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithUser ( const char *  value)
inline

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

Definition at line 2949 of file ContainerDefinition.h.

◆ WithVolumesFrom() [1/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithVolumesFrom ( Aws::Vector< VolumeFrom > &&  value)
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2128 of file ContainerDefinition.h.

◆ WithVolumesFrom() [2/2]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithVolumesFrom ( const Aws::Vector< VolumeFrom > &  value)
inline

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the –volumes-from option to docker run.

Definition at line 2116 of file ContainerDefinition.h.

◆ WithWorkingDirectory() [1/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithWorkingDirectory ( Aws::String &&  value)
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 3034 of file ContainerDefinition.h.

◆ WithWorkingDirectory() [2/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithWorkingDirectory ( const Aws::String value)
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 3022 of file ContainerDefinition.h.

◆ WithWorkingDirectory() [3/3]

ContainerDefinition& Aws::ECS::Model::ContainerDefinition::WithWorkingDirectory ( const char *  value)
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 3046 of file ContainerDefinition.h.

◆ WorkingDirectoryHasBeenSet()

bool Aws::ECS::Model::ContainerDefinition::WorkingDirectoryHasBeenSet ( ) const
inline

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the –workdir option to docker run.

Definition at line 2974 of file ContainerDefinition.h.


The documentation for this class was generated from the following file: