Package software.amazon.awscdk.services.apprunner

Interface CfnService.CodeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.CodeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

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

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.*;
 CodeConfigurationProperty codeConfigurationProperty = CodeConfigurationProperty.builder()
         .configurationSource("configurationSource")
         // the properties below are optional
         .codeConfigurationValues(CodeConfigurationValuesProperty.builder()
                 .runtime("runtime")
                 // the properties below are optional
                 .buildCommand("buildCommand")
                 .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())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.CodeConfigurationProperty.Builder	builder()
default Object	getCodeConfigurationValues()	The basic configuration for building and running the App Runner service.
String	getConfigurationSource()	The source of the App Runner configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationSource

@Stability(Stable)
@NotNull
String getConfigurationSource()

The source of the App Runner configuration. Values are interpreted as follows:.

• REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues .
• API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

getCodeConfigurationValues

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

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).

builder

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

Returns:

a CfnService.CodeConfigurationProperty.Builder of CfnService.CodeConfigurationProperty