/AWS1/CL_ECSDAEMONCONTNRDEFN¶
A container definition for a daemon task. Daemon container definitions describe the containers that run as part of a daemon task on container instances managed by capacity providers.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_image TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The image used to start the 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:tagorrepository-url/image@digest.
Optional arguments:¶
iv_name TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The name of the container. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
iv_memory TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER¶
The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is killed.
iv_memoryreservation TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER¶
The soft limit (in MiB) of memory to reserve for the container.
io_repositorycredentials TYPE REF TO /AWS1/CL_ECSREPOSITORYCREDS /AWS1/CL_ECSREPOSITORYCREDS¶
The private repository authentication credentials to use.
io_healthcheck TYPE REF TO /AWS1/CL_ECSHEALTHCHECK /AWS1/CL_ECSHEALTHCHECK¶
The container health check command and associated configuration parameters for the container.
iv_cpu TYPE /AWS1/ECSINTEGER /AWS1/ECSINTEGER¶
The number of
cpuunits reserved for the container.
iv_essential TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN¶
If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.
it_entrypoint TYPE /AWS1/CL_ECSSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
The entry point that's passed to the container.
it_command TYPE /AWS1/CL_ECSSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
The command that's passed to the container.
iv_workingdirectory TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The working directory to run commands inside the container in.
it_environmentfiles TYPE /AWS1/CL_ECSENVIRONMENTFILE=>TT_ENVIRONMENTFILES TT_ENVIRONMENTFILES¶
A list of files containing the environment variables to pass to a container.
it_environment TYPE /AWS1/CL_ECSKEYVALUEPAIR=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES¶
The environment variables to pass to a container.
it_secrets TYPE /AWS1/CL_ECSSECRET=>TT_SECRETLIST TT_SECRETLIST¶
The secrets to pass to the container.
iv_readonlyrootfilesystem TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN¶
When this parameter is true, the container is given read-only access to its root file system.
it_mountpoints TYPE /AWS1/CL_ECSMOUNTPOINT=>TT_MOUNTPOINTLIST TT_MOUNTPOINTLIST¶
The mount points for data volumes in your container.
io_logconfiguration TYPE REF TO /AWS1/CL_ECSLOGCONFIGURATION /AWS1/CL_ECSLOGCONFIGURATION¶
The log configuration specification for the container.
io_firelensconfiguration TYPE REF TO /AWS1/CL_ECSFIRELENSCONF /AWS1/CL_ECSFIRELENSCONF¶
The FireLens configuration for the container. This is used to specify and configure a log router for container logs.
iv_privileged TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN¶
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser).
iv_user TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The user to use inside the container.
it_ulimits TYPE /AWS1/CL_ECSULIMIT=>TT_ULIMITLIST TT_ULIMITLIST¶
A list of
ulimitsto set in the container.
io_linuxparameters TYPE REF TO /AWS1/CL_ECSDAEMONLINUXPARAMS /AWS1/CL_ECSDAEMONLINUXPARAMS¶
Linux-specific modifications that are applied to the container configuration, such as Linux kernel capabilities.
it_dependson TYPE /AWS1/CL_ECSCONTAINERDEPENDE00=>TT_CONTAINERDEPENDENCIES TT_CONTAINERDEPENDENCIES¶
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition.
iv_starttimeout TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER¶
Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
iv_stoptimeout TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER¶
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
it_systemcontrols TYPE /AWS1/CL_ECSSYSTEMCONTROL=>TT_SYSTEMCONTROLS TT_SYSTEMCONTROLS¶
A list of namespaced kernel parameters to set in the container.
iv_interactive TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN¶
When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated.
iv_pseudoterminal TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN¶
When this parameter is
true, a TTY is allocated.
io_restartpolicy TYPE REF TO /AWS1/CL_ECSCONTAINERRESTRTPLY /AWS1/CL_ECSCONTAINERRESTRTPLY¶
The restart policy for the container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task.
Queryable Attributes¶
name¶
The name of the container. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
image¶
The image used to start the 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:tagorrepository-url/image@digest.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGE() |
Getter for IMAGE, with configurable default |
ASK_IMAGE() |
Getter for IMAGE w/ exceptions if field has no value |
HAS_IMAGE() |
Determine if IMAGE has a value |
memory¶
The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is killed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MEMORY() |
Getter for MEMORY, with configurable default |
ASK_MEMORY() |
Getter for MEMORY w/ exceptions if field has no value |
HAS_MEMORY() |
Determine if MEMORY has a value |
memoryReservation¶
The soft limit (in MiB) of memory to reserve for the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MEMORYRESERVATION() |
Getter for MEMORYRESERVATION, with configurable default |
ASK_MEMORYRESERVATION() |
Getter for MEMORYRESERVATION w/ exceptions if field has no v |
HAS_MEMORYRESERVATION() |
Determine if MEMORYRESERVATION has a value |
repositoryCredentials¶
The private repository authentication credentials to use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REPOSITORYCREDENTIALS() |
Getter for REPOSITORYCREDENTIALS |
healthCheck¶
The container health check command and associated configuration parameters for the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEALTHCHECK() |
Getter for HEALTHCHECK |
cpu¶
The number of
cpuunits reserved for the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CPU() |
Getter for CPU |
essential¶
If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ESSENTIAL() |
Getter for ESSENTIAL, with configurable default |
ASK_ESSENTIAL() |
Getter for ESSENTIAL w/ exceptions if field has no value |
HAS_ESSENTIAL() |
Determine if ESSENTIAL has a value |
entryPoint¶
The entry point that's passed to the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENTRYPOINT() |
Getter for ENTRYPOINT, with configurable default |
ASK_ENTRYPOINT() |
Getter for ENTRYPOINT w/ exceptions if field has no value |
HAS_ENTRYPOINT() |
Determine if ENTRYPOINT has a value |
command¶
The command that's passed to the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMMAND() |
Getter for COMMAND, with configurable default |
ASK_COMMAND() |
Getter for COMMAND w/ exceptions if field has no value |
HAS_COMMAND() |
Determine if COMMAND has a value |
workingDirectory¶
The working directory to run commands inside the container in.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKINGDIRECTORY() |
Getter for WORKINGDIRECTORY, with configurable default |
ASK_WORKINGDIRECTORY() |
Getter for WORKINGDIRECTORY w/ exceptions if field has no va |
HAS_WORKINGDIRECTORY() |
Determine if WORKINGDIRECTORY has a value |
environmentFiles¶
A list of files containing the environment variables to pass to a container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTFILES() |
Getter for ENVIRONMENTFILES, with configurable default |
ASK_ENVIRONMENTFILES() |
Getter for ENVIRONMENTFILES w/ exceptions if field has no va |
HAS_ENVIRONMENTFILES() |
Determine if ENVIRONMENTFILES has a value |
environment¶
The environment variables to pass to a container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENT() |
Getter for ENVIRONMENT, with configurable default |
ASK_ENVIRONMENT() |
Getter for ENVIRONMENT w/ exceptions if field has no value |
HAS_ENVIRONMENT() |
Determine if ENVIRONMENT has a value |
secrets¶
The secrets to pass to the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETS() |
Getter for SECRETS, with configurable default |
ASK_SECRETS() |
Getter for SECRETS w/ exceptions if field has no value |
HAS_SECRETS() |
Determine if SECRETS has a value |
readonlyRootFilesystem¶
When this parameter is true, the container is given read-only access to its root file system.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_READONLYROOTFILESYSTEM() |
Getter for READONLYROOTFILESYSTEM, with configurable default |
ASK_READONLYROOTFILESYSTEM() |
Getter for READONLYROOTFILESYSTEM w/ exceptions if field has |
HAS_READONLYROOTFILESYSTEM() |
Determine if READONLYROOTFILESYSTEM has a value |
mountPoints¶
The mount points for data volumes in your container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MOUNTPOINTS() |
Getter for MOUNTPOINTS, with configurable default |
ASK_MOUNTPOINTS() |
Getter for MOUNTPOINTS w/ exceptions if field has no value |
HAS_MOUNTPOINTS() |
Determine if MOUNTPOINTS has a value |
logConfiguration¶
The log configuration specification for the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGCONFIGURATION() |
Getter for LOGCONFIGURATION |
firelensConfiguration¶
The FireLens configuration for the container. This is used to specify and configure a log router for container logs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FIRELENSCONFIGURATION() |
Getter for FIRELENSCONFIGURATION |
privileged¶
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVILEGED() |
Getter for PRIVILEGED, with configurable default |
ASK_PRIVILEGED() |
Getter for PRIVILEGED w/ exceptions if field has no value |
HAS_PRIVILEGED() |
Determine if PRIVILEGED has a value |
user¶
The user to use inside the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USER() |
Getter for USER, with configurable default |
ASK_USER() |
Getter for USER w/ exceptions if field has no value |
HAS_USER() |
Determine if USER has a value |
ulimits¶
A list of
ulimitsto set in the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ULIMITS() |
Getter for ULIMITS, with configurable default |
ASK_ULIMITS() |
Getter for ULIMITS w/ exceptions if field has no value |
HAS_ULIMITS() |
Determine if ULIMITS has a value |
linuxParameters¶
Linux-specific modifications that are applied to the container configuration, such as Linux kernel capabilities.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LINUXPARAMETERS() |
Getter for LINUXPARAMETERS |
dependsOn¶
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPENDSON() |
Getter for DEPENDSON, with configurable default |
ASK_DEPENDSON() |
Getter for DEPENDSON w/ exceptions if field has no value |
HAS_DEPENDSON() |
Determine if DEPENDSON has a value |
startTimeout¶
Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIMEOUT() |
Getter for STARTTIMEOUT, with configurable default |
ASK_STARTTIMEOUT() |
Getter for STARTTIMEOUT w/ exceptions if field has no value |
HAS_STARTTIMEOUT() |
Determine if STARTTIMEOUT has a value |
stopTimeout¶
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STOPTIMEOUT() |
Getter for STOPTIMEOUT, with configurable default |
ASK_STOPTIMEOUT() |
Getter for STOPTIMEOUT w/ exceptions if field has no value |
HAS_STOPTIMEOUT() |
Determine if STOPTIMEOUT has a value |
systemControls¶
A list of namespaced kernel parameters to set in the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SYSTEMCONTROLS() |
Getter for SYSTEMCONTROLS, with configurable default |
ASK_SYSTEMCONTROLS() |
Getter for SYSTEMCONTROLS w/ exceptions if field has no valu |
HAS_SYSTEMCONTROLS() |
Determine if SYSTEMCONTROLS has a value |
interactive¶
When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INTERACTIVE() |
Getter for INTERACTIVE, with configurable default |
ASK_INTERACTIVE() |
Getter for INTERACTIVE w/ exceptions if field has no value |
HAS_INTERACTIVE() |
Determine if INTERACTIVE has a value |
pseudoTerminal¶
When this parameter is
true, a TTY is allocated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PSEUDOTERMINAL() |
Getter for PSEUDOTERMINAL, with configurable default |
ASK_PSEUDOTERMINAL() |
Getter for PSEUDOTERMINAL w/ exceptions if field has no valu |
HAS_PSEUDOTERMINAL() |
Determine if PSEUDOTERMINAL has a value |
restartPolicy¶
The restart policy for the container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESTARTPOLICY() |
Getter for RESTARTPOLICY |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_DAEMONCONTAINERDEFNLIST¶
TYPES TT_DAEMONCONTAINERDEFNLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSDAEMONCONTNRDEFN WITH DEFAULT KEY
.