software.amazon.awscdk.services.apprunner

Interface ImageConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ImageConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:00.795Z")
 @Stability(value=Experimental)
public interface ImageConfiguration
extends software.amazon.jsii.JsiiSerializable

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

Example:

 import software.amazon.awscdk.core.*;
 DockerImageAsset imageAsset = DockerImageAsset.Builder.create(this, "ImageAssets")
         .directory(join(__dirname, "./docker.assets"))
         .build();
 Service.Builder.create(this, "Service")
         .source(Source.fromAsset(AssetProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .asset(imageAsset)
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImageConfiguration.Builder	builder()
default Map<String,String>	getEnvironment() (experimental) Environment variables that are available to your running App Runner service.
default Number	getPort() (experimental) The port that your application listens to in the container.
default String	getStartCommand() (experimental) 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 Detail

getEnvironment

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnvironment()

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

Default: - no environment variables

getPort

@Stability(value=Experimental)
 @Nullable
default Number getPort()

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

Default: 8080

getStartCommand

@Stability(value=Experimental)
 @Nullable
default String getStartCommand()

(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

builder

@Stability(value=Experimental)
static ImageConfiguration.Builder builder()

Returns:

a ImageConfiguration.Builder of ImageConfiguration