Optional ReadonlyadditionalOptional ReadonlyadditionalAdditional IAM policy statements to append to the service's Task Role
ReadonlyalbALB listener priority for this service. Must be unique within the Fargate cluster ALB (public or private)
ReadonlyapplicationIdentifier for the application this service is part of. Used as the prefix for resource names etc. Not to be confused with 'serviceName' that is the unique name for the actual ECS service to be created. Usually the 'applicationId' would be the same for all services in the current context
ReadonlyautoscalingMetric to use for ECS autoscaling
ReadonlyautoscalingTarget value for the autoscaling. Depends on the selected metric
ReadonlyclusterThe Fargate Cluster
Optional ReadonlycontainerEnvironment variables to pass to the container as key-value pairs
ReadonlycontainerPort the container is listening to
Optional ReadonlycontainerContainer environment variables to securely resolve from SSM ParameterStore Secret (encrypted) parameters at the time of launching the container. Defined as key-value parirs. The value can be either a parameter name or reference to StringParameter resource.
The parameters defined here must exist before launching this service
The KMS key(s) used to encrypt the secret SSM Parameters must be passed in the 'kmsEnvironmentKeys' property
Optional ReadonlycontainerContainer environment variables to resolve from SSM ParameterStore Standard (non-encrypted) parameters at the time of launching the container
The parameters defined here must exist before launching this service
ReadonlycpuProvisioned CPU capacity for the service
Optional ReadonlydatadogProperties for enabling the DataDog agent container as a 'sidecar' for this container service
Optional ReadonlydesiredDesired number of tasks (containers) to launch. Autoscaling aims to keep this number of tasks running at all times
NOTE: Consider not specifying the desiredCount directly, instead allow the AutoScaling to scale
the service to the desired level. The AutoScaling actions work by setting the desiredCount value for
the service. This happens 'outside' of the IaC deployments. If desiredCount is specified here, the
underlying CloudFormation stack for the service will drift when AutoScaling scales the service, causing
possible issues with further deployments. You can control the AutoScaling by setting the minCapacity and
maxCapacity properties accordingly. Setting the desiredCount explicitly is ok if AutoScaling is not
intended to be used for the service.
ReadonlyecrAccount ID of the AWS account that hosts the ECR repository that has the images for this service. Usually this is the application's PROD account. Used to define the required permissions for the container service to use the images
ReadonlyecrARN of the ECR repository that hosts the images for this service
Optional ReadonlyenableEnable cookie-based sticky sessions for this service
ReadonlyenvironmentStandard environment name
Optional ReadonlyephemeralAmount of ephemeral storage reserved for the service in GiB. Must be between 20 and 200 GiB
Optional ReadonlygitName of the SSM param that has current Git commit SHA. Used to tag the container service resources with the current commit SHA that was used to build the container image
Required only if 'gitRepositoryUrl' is defined.
Optional ReadonlygitGit repo URL for this service. Used to tag the container service resources with the Git repository URL that hosts the container image definitions for this service. If enabled, the SSM parameter with the name provided for 'gitCommitShaParamName' (or a parameter that matches the default) must exist before launching this service.
Required to enable version tagging for the service
Optional ReadonlyhealthGrace period for the LoadBalancer health checks. If the container doesn't respond to the health check during this period, it will be marked as unavailable and replaced by auto scaling
Optional ReadonlyhealthApproximate health check interval for the target
ReadonlyhealthURI path to use as the ALB health check for the container. The path must respond to a GET request with a HTTP code of 200 - 399 and not require any authentication or query parameters
Optional ReadonlyhealthTimeout during which no response from the target means a failed health check
ReadonlyhostedPublic HostedZone where the DNS name for the service will be registered. The name will be
Optional ReadonlyimageName of the SSM parameter that defines the container image tag (version) to be deployed.
The SSM parameter must exist before launching the service
ReadonlykmsKMS keys that are used to encrypt the data stores this service needs to access. The IAM role for this service will be granted Read/Write access to these keys
Optional ReadonlykmsKMS key that is used to encrypt the ECR images used by this service. This is required only on the account that hosts the ECR repository.
ReadonlykmsKMS keys that are used to encrypt resources like SSM ParameterStore parameters that are needed in order to launch this service. The ECS Task Execution Role (the IAM role that is used by the ECS service to launch the container services) is granted Read access to these keys
ReadonlylistenerThe Fargate cluster's Application Load Balancer listener where this service will be added
ReadonlyloadThe Fargate cluster's Application Load Balancer that is used for this service (public or private ALB)
Optional ReadonlyloadLoad balancing algorithm
Optional ReadonlylogLogGroupClass for the CloudWatch LogGroup for this service's logs
ReadonlylogCloudWatch log retention for the log group for this service
ReadonlymaxMaximum value the Auto Scaling will scale the service to during scaling activity
Optional ReadonlymaxThe maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
ReadonlymemoryMemory limit for the Fargate Task in GiB. Allowed values depend on the specified CPU capacity.
ReadonlyminMinimum value the Auto Scaling will scale the service to during scaling activity
Optional ReadonlyminThe minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
Optional ReadonlyreadonlyGive the container only ReadOnly access to its root file system.
NOTE: It's best practice to enable this feature to restrict a possible attacker's ability to try to break out from the container and gain wider system access. However, many services don't work correctly when this is enabled. Test your service thoroughly before enabling
Optional ReadonlyscaleCooldown period after AutoScaling scale-in action, before next scale-in can be started. Controls how fast the AutoScaling reacts to reducing service load
Optional ReadonlyscaleCooldown period after AutoScaling scale-out action, before next scale-out can be started. Controls how fast the AutoScaling reacts to increasing service load
ReadonlyserviceShared ServiceLinkedRole for the service auto scaling
ReadonlyserviceName of the service to launch. Must be a DNS-safe string. Will be forced to the kebab-case convention (for example: my-service-name)
ReadonlyserviceScope of the Fargate service
ReadonlyserviceType of the Fargate service
Optional ReadonlystickinessName of the cookie to use for session stickiness
Optional ReadonlystickinessDuration of the session stickiness. Required if session stickiness is enabled
Optional ReadonlytaskAdditional permissions to add to the ECS Task Execution Role used to launch the services
Optional ReadonlyvpcVPC to deploy the cluster and services to
Optional ReadonlyvpcPrivate subnets of the VPC
Additional Host header values to route to this service