Package software.amazon.awscdk.services.apprunner.alpha

Interface CodeConfigurationValues

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CodeConfigurationValues.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:39.142Z") @Stability(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();

  • Method Details

    • getRuntime

      @Stability(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(Experimental) @Nullable default String getBuildCommand()
      (experimental) The command App Runner runs to build your application.

      Default: - no build command.

    • getEnvironment

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,String> getEnvironment()
      Deprecated.
      use environmentVariables.
      (deprecated) The environment variables that are available to your running App Runner service.

      Default: - no environment variables.

    • getEnvironmentSecrets

      @Stability(Experimental) @Nullable default Map<String,Secret> getEnvironmentSecrets()
      (experimental) The environment secrets that are available to your running App Runner service.

      Default: - no environment secrets.

    • getEnvironmentVariables

      @Stability(Experimental) @Nullable default Map<String,String> getEnvironmentVariables()
      (experimental) The environment variables that are available to your running App Runner service.

      Default: - no environment variables.

    • getPort

      @Stability(Experimental) @Nullable default String getPort()
      (experimental) The port that your application listens to in the container.

      Default: 8080

    • getStartCommand

      @Stability(Experimental) @Nullable default String getStartCommand()
      (experimental) The command App Runner runs to start your application.

      Default: - no start command.

    • builder

      @Stability(Experimental) static CodeConfigurationValues.Builder builder()
      Returns:
      a CodeConfigurationValues.Builder of CodeConfigurationValues