latest--rd-web-service

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

Request-Driven Web Service manifest for AWS Copilot https://aws.github.io/copilot-cli/docs/manifest/rd-web-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. A Request-Driven Web Service is an internet-facing service that is deployed on AWS App Runner.

Constant: "Request-Driven Web Service"
http object

The http section contains parameters related to the managed load balancer.

3 nested properties
private boolean | object
healthcheck string | object
alias string

Assign a friendly domain name to your request-driven web services. To learn more see developing/domain.

image object

The image section contains parameters relating to the Docker build configuration and exposed port.

One of: variant, variant
3 nested properties
build string | object
location string

Instead of building a container from a Dockerfile, you can specify an existing image name. Mutually exclusive with image.build. Note: Only public images stored in Amazon ECR Public are available with AWS App Runner.

port integer

The port exposed in your Dockerfile. Copilot should parse this value for you from your EXPOSE instruction.

min=1max=65535
cpu integer

Number of CPU units reserved for each instance of your service. See the AWS App Runner docs for valid CPU values.

Values: 256 512 1024 2048
memory integer

Amount of memory in MiB reserved for each instance of your service. See the AWS App Runner docs for valid memory values.

Values: 512 1024 2048 3072 4096 6144 8192 10240 12288
network object

The network section contains parameters for connecting the service to AWS resources in the environment's VPC.

1 nested properties
vpc object

Subnets in the VPC to route egress traffic from the service.

1 nested properties
placement string required

The only valid option today is 'private'. If you prefer the service not to be connected to a VPC, you can remove the network field.

Values: "private"
observability observability

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

command command

Optional. Override the default command in the image.

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.

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.

publish publish

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

tags Record<string, string>

Key-value pairs representing AWS tags that are passed down to your AWS App Runner resources.

count string

Specify the name of an existing autoscaling configuration.

environments environments

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