Skip to content

ImageConfiguration

Source code in docs_src/capo_apprunner/types/image_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class ImageConfiguration(TypedDict, closed=True):
    runtime_environment_variables: NotRequired[
        "capo_apprunner.types.runtime_environment_variables.RuntimeEnvironmentVariables"
    ]
    """<p>Environment variables that are available to your running App Runner service. An array of key-value pairs.</p>"""
    start_command: NotRequired["capo_apprunner.types.start_command.StartCommand"]
    """<p>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.</p>"""
    port: NotRequired["capo_apprunner.types.string.String"]
    """<p>The port that your application listens to in the container.</p> <p>Default: <code>8080</code> </p>"""
    runtime_environment_secrets: NotRequired[
        "capo_apprunner.types.runtime_environment_secrets.RuntimeEnvironmentSecrets"
    ]
    """<p>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 Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.</p> <note> <ul> <li> <p> If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services 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. </p> </li> <li> <p> Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported. </p> </li> </ul> </note>"""

port instance-attribute 

port: NotRequired[String]

The port that your application listens to in the container.

Default: 8080

runtime_environment_secrets instance-attribute 

runtime_environment_secrets: NotRequired[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 Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

  • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services 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 Web Services Systems Manager Parameter Store parameter is not supported.

runtime_environment_variables instance-attribute 

runtime_environment_variables: NotRequired[RuntimeEnvironmentVariables]

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

start_command instance-attribute 

start_command: NotRequired[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.