latest--worker-service

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/aws-copilot-manifest/_shared/latest--worker-service.json
Parent schema aws-copilot-manifest
Type: object

Worker Service manifest for AWS Copilot https://aws.github.io/copilot-cli/docs/manifest/worker-service/

Properties

name string required

The name of your service.

pattern=^[a-zA-Z][a-zA-Z0-9-]*$
type string required

The architecture type for your service. Worker Services are not reachable from the internet or elsewhere in the VPC. They are designed to pull messages from their associated SQS queues, which are populated by their subscriptions to SNS topics created by other Copilot services' publish fields.

Constant: "Worker Service"
subscribe subscribe-config required

The subscribe section allows worker services to create subscriptions to the SNS topics exposed by other Copilot services in the same application and environment.

image image-config

The image section contains parameters relating to the Docker build configuration or referring to an existing container image.

cpu cpu
memory memory
platform platform
count integer | object | object

The number of tasks that your service should maintain.

exec boolean

Enable running commands in your container. The default is false. Required for $ copilot svc exec.

deployment deployment

The deployment section contains parameters to control how many tasks run during the deployment and the ordering of stopping and starting tasks.

entrypoint entrypoint
command command
network network

The network section contains parameters for connecting to AWS resources in a VPC.

variables environment-variables

Key-value pairs that represent environment variables that will be passed to your service. Copilot will include a number of environment variables by default for you.

env_file string

The path to a file from the root of your workspace containing the environment variables to pass to the main container. For more information about the environment variable file, see Considerations for specifying environment variable files.

secrets secrets

Key-value pairs that represent secret values from AWS Systems Manager Parameter Store or AWS Secrets Manager that will be securely passed to your service as environment variables.

storage storage

The Storage section lets you specify external EFS volumes for your containers and sidecars to mount. This allows you to access persistent storage across availability zones in a region for data processing or CMS workloads. For more detail, see the storage page. You can also specify extensible ephemeral storage at the task level.

publish publish

The publish section allows services to publish messages to one or more SNS topics.

logging logging

The logging section contains log configuration. You can also configure parameters for your container's FireLens log driver in this section.

observability observability

The observability section lets you configure ways to measure your service's current state. Currently, only tracing configuration is supported.

taskdef_overrides taskdef-override[]

The taskdef_overrides section allows users to apply overriding rules to their ECS Task Definitions.

environments environments

The environment section lets you override any value in your manifest based on the environment you're in.