Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-ecs-taskdefinition.json
Parent schema serverless-framework-configuration
Type: object

Resource Schema describing various properties for ECS TaskDefinition. Source:- https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html

Properties

Family string | Aws_CF_FunctionString
ContainerDefinitions ContainerDefinition[]
uniqueItems=true
Cpu string | Aws_CF_FunctionString
ExecutionRoleArn string | Aws_CF_FunctionString
EphemeralStorage object
1 nested properties
SizeInGiB integer
InferenceAccelerators InferenceAccelerator[]
uniqueItems=true
Memory string | Aws_CF_FunctionString
NetworkMode string | Aws_CF_FunctionString
uniqueItems=true
ProxyConfiguration object
3 nested properties
ContainerName string | Aws_CF_FunctionString required
ProxyConfigurationProperties KeyValuePair[]
uniqueItems=true
Type string | Aws_CF_FunctionString
RequiresCompatibilities string[]
uniqueItems=true
TaskRoleArn string | Aws_CF_FunctionString
Volumes Volume[]
uniqueItems=true
PidMode string | Aws_CF_FunctionString
RuntimePlatform object
2 nested properties
CpuArchitecture string | Aws_CF_FunctionString
OperatingSystemFamily string | Aws_CF_FunctionString
IpcMode string | Aws_CF_FunctionString
Tags Tag[]

Definitions

ContainerDefinition object

List of container definitions that are passed to the Docker daemon on a container instance

Image string | Aws_CF_FunctionString required

The image used to start a container. This string is passed directly to the Docker daemon.

Name string | Aws_CF_FunctionString required

The name of a container. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed

Command string[]
Cpu integer
DisableNetworking boolean
DnsSearchDomains string[]
DnsServers string[]
DockerLabels object
DockerSecurityOptions string[]
EntryPoint string[]
Environment KeyValuePair[]

The environment variables to pass to a container

uniqueItems=true
EnvironmentFiles EnvironmentFile[]

The list of one or more files that contain the environment variables to pass to a container

Essential boolean
ExtraHosts HostEntry[]
FirelensConfiguration object
2 nested properties
Type string | Aws_CF_FunctionString
Options object
HealthCheck object

The health check command and associated configuration parameters for the container.

5 nested properties
Command string[]

A string array representing the command that the container runs to determine if it is healthy.

Interval integer

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

Timeout integer

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.

Retries integer

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is three retries.

StartPeriod integer

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

Hostname string | Aws_CF_FunctionString
Links string[]
uniqueItems=true
LinuxParameters object
7 nested properties
Capabilities object
2 nested properties
Add string[]
Drop string[]
Devices Device[]
InitProcessEnabled boolean
MaxSwap integer
SharedMemorySize integer
Swappiness integer
Tmpfs Tmpfs[]
LogConfiguration object
3 nested properties
LogDriver string | Aws_CF_FunctionString required
Options object
SecretOptions Secret[]
Memory integer

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.

MemoryReservation integer
MountPoints MountPoint[]
uniqueItems=true
PortMappings PortMapping[]

Port mappings allow containers to access ports on the host container instance to send or receive traffic.

uniqueItems=true
Privileged boolean
ReadonlyRootFilesystem boolean
RepositoryCredentials object
1 nested properties
CredentialsParameter string | Aws_CF_FunctionString
ResourceRequirements ResourceRequirement[]
Secrets Secret[]
StartTimeout integer
StopTimeout integer
Ulimits Ulimit[]
User string | Aws_CF_FunctionString
VolumesFrom VolumeFrom[]
uniqueItems=true
WorkingDirectory string | Aws_CF_FunctionString
Interactive boolean
PseudoTerminal boolean
SystemControls SystemControl[]
SystemControl object
Namespace string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString
ContainerDependency object
ContainerName string | Aws_CF_FunctionString
Condition string | Aws_CF_FunctionString
Device object
ContainerPath string | Aws_CF_FunctionString
HostPath string | Aws_CF_FunctionString
Permissions string[]
uniqueItems=true
DockerVolumeConfiguration object
Autoprovision boolean
Driver string | Aws_CF_FunctionString
DriverOpts object
Labels object
Scope string | Aws_CF_FunctionString
AuthorizationConfig object
IAM string | Aws_CF_FunctionString
AccessPointId string | Aws_CF_FunctionString
EFSVolumeConfiguration object
FilesystemId string | Aws_CF_FunctionString required
RootDirectory string | Aws_CF_FunctionString
TransitEncryption string | Aws_CF_FunctionString
TransitEncryptionPort integer
AuthorizationConfig object
2 nested properties
IAM string | Aws_CF_FunctionString
AccessPointId string | Aws_CF_FunctionString
EnvironmentFile object
Value string | Aws_CF_FunctionString
Type string | Aws_CF_FunctionString
EphemeralStorage object
SizeInGiB integer
FirelensConfiguration object
Type string | Aws_CF_FunctionString
Options object
HealthCheck object

The health check command and associated configuration parameters for the container.

Command string[]

A string array representing the command that the container runs to determine if it is healthy.

Interval integer

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

Timeout integer

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.

Retries integer

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is three retries.

StartPeriod integer

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

HostEntry object
Hostname string | Aws_CF_FunctionString
IpAddress string | Aws_CF_FunctionString
HostVolumeProperties object
SourcePath string | Aws_CF_FunctionString
InferenceAccelerator object
DeviceName string | Aws_CF_FunctionString
DeviceType string | Aws_CF_FunctionString
KernelCapabilities object
Add string[]
Drop string[]
KeyValuePair object
Name string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString
LinuxParameters object
Capabilities object
2 nested properties
Add string[]
Drop string[]
Devices Device[]
InitProcessEnabled boolean
MaxSwap integer
SharedMemorySize integer
Swappiness integer
Tmpfs Tmpfs[]
LogConfiguration object
LogDriver string | Aws_CF_FunctionString required
Options object
SecretOptions Secret[]
PortMapping object
Name string | Aws_CF_FunctionString
ContainerPort integer
ContainerPortRange string | Aws_CF_FunctionString
HostPort integer
Protocol string | Aws_CF_FunctionString
AppProtocol string | Aws_CF_FunctionString
MountPoint object
ContainerPath string | Aws_CF_FunctionString
ReadOnly boolean
SourceVolume string | Aws_CF_FunctionString
ProxyConfiguration object
ContainerName string | Aws_CF_FunctionString required
ProxyConfigurationProperties KeyValuePair[]
uniqueItems=true
Type string | Aws_CF_FunctionString
RepositoryCredentials object
CredentialsParameter string | Aws_CF_FunctionString
ResourceRequirement object
Type string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
RuntimePlatform object
CpuArchitecture string | Aws_CF_FunctionString
OperatingSystemFamily string | Aws_CF_FunctionString
Secret object
Name string | Aws_CF_FunctionString required
ValueFrom string | Aws_CF_FunctionString required
TaskDefinitionPlacementConstraint object
Type string | Aws_CF_FunctionString required
Expression string | Aws_CF_FunctionString
Tmpfs object
Size integer required
ContainerPath string | Aws_CF_FunctionString
MountOptions string[]
Ulimit object
HardLimit integer required
Name string | Aws_CF_FunctionString required
SoftLimit integer required
Volume object
DockerVolumeConfiguration object
5 nested properties
Autoprovision boolean
Driver string | Aws_CF_FunctionString
DriverOpts object
Labels object
Scope string | Aws_CF_FunctionString
EFSVolumeConfiguration object
5 nested properties
FilesystemId string | Aws_CF_FunctionString required
RootDirectory string | Aws_CF_FunctionString
TransitEncryption string | Aws_CF_FunctionString
TransitEncryptionPort integer
AuthorizationConfig object
2 nested properties
IAM string | Aws_CF_FunctionString
AccessPointId string | Aws_CF_FunctionString
Host object
1 nested properties
SourcePath string | Aws_CF_FunctionString
Name string | Aws_CF_FunctionString
VolumeFrom object
ReadOnly boolean
SourceContainer string | Aws_CF_FunctionString
Tag object
Key string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString