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

Interface CodeConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.621Z")
@Stability(Experimental)
public interface CodeConfiguration
extends software.amazon.jsii.JsiiSerializable

(experimental) Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code 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.alpha.*;
 Runtime runtime;
 Secret secret;
 CodeConfiguration codeConfiguration = CodeConfiguration.builder()
         .configurationSource(ConfigurationSourceType.REPOSITORY)
         // the properties below are optional
         .configurationValues(CodeConfigurationValues.builder()
                 .runtime(runtime)
                 // the properties below are optional
                 .buildCommand("buildCommand")
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .environmentSecrets(Map.of(
                         "environmentSecretsKey", secret))
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", "environmentVariables"))
                 .port("port")
                 .startCommand("startCommand")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CodeConfiguration.Builder	builder()
ConfigurationSourceType	getConfigurationSource()	(experimental) The source of the App Runner configuration.
default CodeConfigurationValues	getConfigurationValues()	(experimental) The basic configuration for building and running the App Runner service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationSource

@Stability(Experimental)
@NotNull
ConfigurationSourceType getConfigurationSource()

(experimental) The source of the App Runner configuration.

getConfigurationValues

@Stability(Experimental)
@Nullable
default CodeConfigurationValues getConfigurationValues()

(experimental) The basic configuration for building and running the App Runner service.

Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

Default: - not specified. Use `apprunner.yaml` instead.

builder

@Stability(Experimental)
static CodeConfiguration.Builder builder()

Returns:

a CodeConfiguration.Builder of CodeConfiguration