Package software.amazon.awscdk.services.apprunner

Interface CfnService.ImageConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ImageConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

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

Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image 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.*;
 ImageConfigurationProperty imageConfigurationProperty = ImageConfigurationProperty.builder()
         .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-imageconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.ImageConfigurationProperty.Builder	builder()
default String	getPort()	The port that your application listens to in the container.
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()	Environment variables that are available to your running App Runner service.
default String	getStartCommand()	An optional command that App Runner runs to start the application in the source image.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-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-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentsecrets

getRuntimeEnvironmentVariables

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

Environment variables that are available to your running App Runner service.

An array of key-value pairs.

See Also:

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

getStartCommand

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

An optional command that App Runner runs to start the application in the source image.

If specified, this command overrides the Docker image’s default start command.

See Also:

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

builder

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

Returns:

a CfnService.ImageConfigurationProperty.Builder of CfnService.ImageConfigurationProperty