Package software.amazon.awscdk.services.apprunner

Interface CfnService.ImageConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ImageConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.ImageConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apprunner.*;
 ImageConfigurationProperty imageConfigurationProperty = ImageConfigurationProperty.builder()
         .port("port")
         .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .startCommand("startCommand")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.ImageConfigurationProperty.Builder	A builder for CfnService.ImageConfigurationProperty
static final class	CfnService.ImageConfigurationProperty.Jsii$Proxy	An implementation for CfnService.ImageConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.ImageConfigurationProperty.Builder	builder()
default String	getPort()	The port that your application listens to in the container.
default Object	getRuntimeEnvironmentSecrets()	CfnService.ImageConfigurationProperty.RuntimeEnvironmentSecrets.
default Object	getRuntimeEnvironmentVariables()	Environment variables that are available to your running App Runner service.
default String	getStartCommand()	An optional command that App Runner runs to start the application in the source image.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@Nullable
default String getPort()

The port that your application listens to in the container.

Default: 8080

getRuntimeEnvironmentSecrets

@Stability(Stable)
@Nullable
default Object getRuntimeEnvironmentSecrets()

CfnService.ImageConfigurationProperty.RuntimeEnvironmentSecrets.

getRuntimeEnvironmentVariables

@Stability(Stable)
@Nullable
default Object getRuntimeEnvironmentVariables()

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

An array of key-value pairs.

getStartCommand

@Stability(Stable)
@Nullable
default String getStartCommand()

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.

builder

@Stability(Stable)
static CfnService.ImageConfigurationProperty.Builder builder()

Returns:

a CfnService.ImageConfigurationProperty.Builder of CfnService.ImageConfigurationProperty