latest--scheduled-job

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

Scheduled Job manifest for AWS Copilot https://aws.github.io/copilot-cli/docs/manifest/scheduled-job/

Properties

name string required

The name of your job.

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

The architecture type for your job. Currently, Copilot only supports the 'Scheduled Job' type for tasks that are triggered either on a fixed schedule or periodically.

Constant: "Scheduled Job"
on object required

The configuration for the event that triggers your job.

1 nested properties
schedule string | string | string | string | string required

You can specify a rate to periodically trigger your job or a cron schedule if you'd like to trigger the job at a specific time.

image image-config

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

entrypoint entrypoint
command command
cpu cpu
memory memory
platform platform
retries integer

The number of times to retry the job before failing.

min=0
timeout duration

How long the job should run before it aborts and fails. You can use the units: h, m, or s.

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 job. 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 that will be securely passed to your job 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 regions for data processing or CMS workloads.

logging logging

The logging section contains log configuration parameters for your container's FireLens log driver.

publish publish

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

environments environments

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