Package software.amazon.awscdk.services.apprunner

Interface CfnService.CodeConfigurationValuesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.CodeConfigurationValuesProperty.Jsii$Proxy

Enclosing class:

CfnService

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

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:

 // 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.*;
 CodeConfigurationValuesProperty codeConfigurationValuesProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.CodeConfigurationValuesProperty.Builder	builder()
default String	getBuildCommand()	The command App Runner runs to build your application.
default String	getPort()	The port that your application listens to in the container.
String	getRuntime()	A runtime environment type for building and running an App Runner service.
default Object	getRuntimeEnvironmentSecrets()	An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.
default Object	getRuntimeEnvironmentVariables()	The environment variables that are available to your running AWS App Runner service.
default String	getStartCommand()	The command App Runner runs to start your application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuntime

@Stability(Stable)
@NotNull
String getRuntime()

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

It represents a programming language runtime.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtime

getBuildCommand

@Stability(Stable)
@Nullable
default String getBuildCommand()

The command App Runner runs to build your application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-buildcommand

getPort

@Stability(Stable)
@Nullable
default String getPort()

The port that your application listens to in the container.

Default: 8080

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-port

getRuntimeEnvironmentSecrets

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

An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.

The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

• If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
• Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentsecrets

getRuntimeEnvironmentVariables

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

The environment variables that are available to your running AWS App Runner service.

An array of key-value pairs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentvariables

getStartCommand

@Stability(Stable)
@Nullable
default String getStartCommand()

The command App Runner runs to start your application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-startcommand

builder

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

Returns:

a CfnService.CodeConfigurationValuesProperty.Builder of CfnService.CodeConfigurationValuesProperty