software.amazon.awscdk.services.apprunner

Interface CodeConfigurationValues

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeConfigurationValues.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:24.562Z")
 @Stability(value=Experimental)
public interface CodeConfigurationValues
extends software.amazon.jsii.JsiiSerializable

(experimental) Describes the basic configuration needed for building and running an AWS App Runner service.

This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

Example:

 Service.Builder.create(this, "Service")
         .source(Source.fromGitHub(GithubRepositoryProps.builder()
                 .repositoryUrl("https://github.com/aws-containers/hello-app-runner")
                 .branch("main")
                 .configurationSource(ConfigurationSourceType.API)
                 .codeConfigurationValues(CodeConfigurationValues.builder()
                         .runtime(Runtime.PYTHON_3)
                         .port("8000")
                         .startCommand("python app.py")
                         .buildCommand("yum install -y pycairo && pip install -r requirements.txt")
                         .build())
                 .connection(GitHubConnection.fromConnectionArn("CONNECTION_ARN"))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CodeConfigurationValues.Builder	builder()
default String	getBuildCommand() (experimental) The command App Runner runs to build your application.
default Map<String,String>	getEnvironment() (experimental) The environment variables that are available to your running App Runner service.
default String	getPort() (experimental) The port that your application listens to in the container.
Runtime	getRuntime() (experimental) A runtime environment type for building and running an App Runner service.
default String	getStartCommand() (experimental) The command App Runner runs to start your application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRuntime

@Stability(value=Experimental)
 @NotNull
Runtime getRuntime()

(experimental) A runtime environment type for building and running an App Runner service.

It represents a programming language runtime.

getBuildCommand

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

(experimental) The command App Runner runs to build your application.

Default: - no build command.

getEnvironment

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

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

Default: - no environment variables.

getPort

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

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

Default: 8080

getStartCommand

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

(experimental) The command App Runner runs to start your application.

Default: - no start command.

builder

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

Returns:

a CodeConfigurationValues.Builder of CodeConfigurationValues