Interface CfnServicePropsMixin.IImageConfigurationProperty

Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.AppRunner

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnServicePropsMixin.IImageConfigurationProperty

Syntax (vb)

Public Interface CfnServicePropsMixin.IImageConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.AppRunner;

             var imageConfigurationProperty = new ImageConfigurationProperty {
                 Port = "port",
                 RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
                     Name = "name",
                     Value = "value"
                 } },
                 RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
                     Name = "name",
                     Value = "value"
                 } },
                 StartCommand = "startCommand"
             };

Synopsis

Properties

Port	The port that your application listens to in the container.
RuntimeEnvironmentSecrets	An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.
RuntimeEnvironmentVariables	Environment variables that are available to your running App Runner service.
StartCommand	An optional command that App Runner runs to start the application in the source image.

Properties

Port

The port that your application listens to in the container.

string? Port { get; }

Property Value

string

Remarks

Default: 8080

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

RuntimeEnvironmentSecrets

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

object? RuntimeEnvironmentSecrets { get; }

Property Value

object

Remarks

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.

<ul></ul>

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

Type union: either IResolvable or (either IResolvable or CfnServicePropsMixin.IKeyValuePairProperty)[]

RuntimeEnvironmentVariables

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

object? RuntimeEnvironmentVariables { get; }

Property Value

object

Remarks

An array of key-value pairs.

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

Type union: either IResolvable or (either IResolvable or CfnServicePropsMixin.IKeyValuePairProperty)[]

StartCommand

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

string? StartCommand { get; }

Property Value

string

Remarks

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

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