AWS::AppRunner::Service ImageConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::AppRunner::Service ImageConfiguration

Describes the configuration that Amazon App Runner uses to run an App Runner service using an image pulled from a source image repository.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Port" : String,
  "RuntimeEnvironmentSecrets" : [ KeyValuePair, ... ],
  "RuntimeEnvironmentVariables" : [ KeyValuePair, ... ],
  "StartCommand" : String
}

Properties

Port

The port that your application listens to in the container.

Default: 8080

Required: No

Type: String

Pattern: .*

Minimum: 0

Maximum: 51200

Update requires: No interruption

RuntimeEnvironmentSecrets

An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Amazon Secrets Manager secret or the full ARN of the parameter in the Amazon Systems Manager Parameter Store.

Note

  • If the Amazon Systems Manager Parameter Store parameter exists in the same Amazon Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.

  • Currently, cross account referencing of Amazon Systems Manager Parameter Store parameter is not supported.

Required: No

Type: Array of KeyValuePair

Update requires: No interruption

RuntimeEnvironmentVariables

Environment variables that are available to your running App Runner service. An array of key-value pairs.

Required: No

Type: Array of KeyValuePair

Update requires: No interruption

StartCommand

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

Required: No

Type: String

Pattern: [^\x0a\x0d]+

Update requires: No interruption