ImageConfiguration

class aws_cdk.aws_apprunner.ImageConfiguration(*, environment=None, port=None, start_command=None)

Bases: object

(experimental) Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.

Parameters
  • environment (Optional[Mapping[str, str]]) – (experimental) Environment variables that are available to your running App Runner service. Default: - no environment variables

  • port (Union[int, float, None]) – (experimental) The port that your application listens to in the container. Default: 8080

  • start_command (Optional[str]) – (experimental) 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. Default: - no start command

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html

Stability

experimental

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apprunner as apprunner

image_configuration = apprunner.ImageConfiguration(
    environment={
        "environment_key": "environment"
    },
    port=123,
    start_command="startCommand"
)

Attributes

environment

(experimental) Environment variables that are available to your running App Runner service.

Default
  • no environment variables

Stability

experimental

Return type

Optional[Mapping[str, str]]

port

(experimental) The port that your application listens to in the container.

Default

8080

Stability

experimental

Return type

Union[int, float, None]

start_command

(experimental) 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.

Default
  • no start command

Stability

experimental

Return type

Optional[str]