Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apprunner-service.json
Parent schema serverless-framework-configuration
Type: object

The AWS::AppRunner::Service resource specifies an AppRunner Service.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apprunner.git

Properties

SourceConfiguration object required

Source Code configuration

4 nested properties
CodeRepository object

Source Code Repository

3 nested properties
RepositoryUrl string | Aws_CF_FunctionString required

Repository Url

SourceCodeVersion object required

Source Code Version

2 nested properties
Type string | Aws_CF_FunctionString required

Source Code Version Type

Value string | Aws_CF_FunctionString required

Source Code Version Value

CodeConfiguration object

Code Configuration

2 nested properties
ConfigurationSource string | Aws_CF_FunctionString required

Configuration Source

CodeConfigurationValues object

Code Configuration Values

ImageRepository object

Image Repository

3 nested properties
ImageIdentifier string | Aws_CF_FunctionString required

Image Identifier

ImageRepositoryType string | Aws_CF_FunctionString required

Image Repository Type

ImageConfiguration object

Image Configuration

4 nested properties
StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

AutoDeploymentsEnabled boolean

Auto Deployment enabled

AuthenticationConfiguration object

Authentication Configuration

2 nested properties
ConnectionArn string | Aws_CF_FunctionString

Connection Arn

AccessRoleArn string | Aws_CF_FunctionString
ServiceName string | Aws_CF_FunctionString

The AppRunner Service Name.

InstanceConfiguration object

Instance Configuration

3 nested properties
Cpu string | Aws_CF_FunctionString

CPU

Memory string | Aws_CF_FunctionString

Memory

InstanceRoleArn string | Aws_CF_FunctionString
Tags Tag[]
EncryptionConfiguration object

Encryption configuration (KMS key)

1 nested properties
KmsKey string | Aws_CF_FunctionString required

The KMS Key

HealthCheckConfiguration object

Health check configuration

6 nested properties
Protocol string | Aws_CF_FunctionString

Health Check Protocol

Path string | Aws_CF_FunctionString

Health check Path

Interval integer

Health check Interval

Timeout integer

Health check Timeout

min=1max=20
HealthyThreshold integer

Health check Healthy Threshold

min=1max=20
UnhealthyThreshold integer

Health check Unhealthy Threshold

min=1max=20
ObservabilityConfiguration object

Service observability configuration

2 nested properties
ObservabilityEnabled boolean required

Observability enabled

ObservabilityConfigurationArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.

AutoScalingConfigurationArn string | Aws_CF_FunctionString

Autoscaling configuration ARN

NetworkConfiguration object

Network configuration

2 nested properties
EgressConfiguration object

Network egress configuration

2 nested properties
EgressType string | Aws_CF_FunctionString required

Network egress type.

VpcConnectorArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the App Runner VpcConnector.

IngressConfiguration object

Network ingress configuration

1 nested properties
IsPubliclyAccessible boolean required

It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.

Definitions

SourceConfiguration object

Source Code configuration

CodeRepository object

Source Code Repository

3 nested properties
RepositoryUrl string | Aws_CF_FunctionString required

Repository Url

SourceCodeVersion object required

Source Code Version

2 nested properties
Type string | Aws_CF_FunctionString required

Source Code Version Type

Value string | Aws_CF_FunctionString required

Source Code Version Value

CodeConfiguration object

Code Configuration

2 nested properties
ConfigurationSource string | Aws_CF_FunctionString required

Configuration Source

CodeConfigurationValues object

Code Configuration Values

ImageRepository object

Image Repository

3 nested properties
ImageIdentifier string | Aws_CF_FunctionString required

Image Identifier

ImageRepositoryType string | Aws_CF_FunctionString required

Image Repository Type

ImageConfiguration object

Image Configuration

4 nested properties
StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

AutoDeploymentsEnabled boolean

Auto Deployment enabled

AuthenticationConfiguration object

Authentication Configuration

2 nested properties
ConnectionArn string | Aws_CF_FunctionString

Connection Arn

AccessRoleArn string | Aws_CF_FunctionString
CodeRepository object

Source Code Repository

RepositoryUrl string | Aws_CF_FunctionString required

Repository Url

SourceCodeVersion object required

Source Code Version

2 nested properties
Type string | Aws_CF_FunctionString required

Source Code Version Type

Value string | Aws_CF_FunctionString required

Source Code Version Value

CodeConfiguration object

Code Configuration

2 nested properties
ConfigurationSource string | Aws_CF_FunctionString required

Configuration Source

CodeConfigurationValues object

Code Configuration Values

6 nested properties
Runtime string | Aws_CF_FunctionString required

Runtime

BuildCommand string | Aws_CF_FunctionString

Build Command

StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

SourceCodeVersion object

Source Code Version

Type string | Aws_CF_FunctionString required

Source Code Version Type

Value string | Aws_CF_FunctionString required

Source Code Version Value

CodeConfiguration object

Code Configuration

ConfigurationSource string | Aws_CF_FunctionString required

Configuration Source

CodeConfigurationValues object

Code Configuration Values

6 nested properties
Runtime string | Aws_CF_FunctionString required

Runtime

BuildCommand string | Aws_CF_FunctionString

Build Command

StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

CodeConfigurationValues object

Code Configuration Values

Runtime string | Aws_CF_FunctionString required

Runtime

BuildCommand string | Aws_CF_FunctionString

Build Command

StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

ImageRepository object

Image Repository

ImageIdentifier string | Aws_CF_FunctionString required

Image Identifier

ImageRepositoryType string | Aws_CF_FunctionString required

Image Repository Type

ImageConfiguration object

Image Configuration

4 nested properties
StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

ImageConfiguration object

Image Configuration

StartCommand string | Aws_CF_FunctionString

Start Command

Port string | Aws_CF_FunctionString

Port

RuntimeEnvironmentVariables KeyValuePair[]
RuntimeEnvironmentSecrets KeyValuePair[]

The secrets and parameters that get referenced by your service as environment variables

AuthenticationConfiguration object

Authentication Configuration

ConnectionArn string | Aws_CF_FunctionString

Connection Arn

AccessRoleArn string | Aws_CF_FunctionString
InstanceConfiguration object

Instance Configuration

Cpu string | Aws_CF_FunctionString

CPU

Memory string | Aws_CF_FunctionString

Memory

InstanceRoleArn string | Aws_CF_FunctionString
RoleArn string | Aws_CF_FunctionString
EncryptionConfiguration object

Encryption configuration (KMS key)

KmsKey string | Aws_CF_FunctionString required

The KMS Key

HealthCheckConfiguration object

Health check configuration

Protocol string | Aws_CF_FunctionString

Health Check Protocol

Path string | Aws_CF_FunctionString

Health check Path

Interval integer

Health check Interval

Timeout integer

Health check Timeout

min=1max=20
HealthyThreshold integer

Health check Healthy Threshold

min=1max=20
UnhealthyThreshold integer

Health check Unhealthy Threshold

min=1max=20
EgressConfiguration object

Network egress configuration

EgressType string | Aws_CF_FunctionString required

Network egress type.

VpcConnectorArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the App Runner VpcConnector.

IngressConfiguration object

Network ingress configuration

IsPubliclyAccessible boolean required

It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.

NetworkConfiguration object

Network configuration

EgressConfiguration object

Network egress configuration

2 nested properties
EgressType string | Aws_CF_FunctionString required

Network egress type.

VpcConnectorArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the App Runner VpcConnector.

IngressConfiguration object

Network ingress configuration

1 nested properties
IsPubliclyAccessible boolean required

It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.

ServiceObservabilityConfiguration object

Service observability configuration

ObservabilityEnabled boolean required

Observability enabled

ObservabilityConfigurationArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.

Tag object
Key string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString
KeyValuePair object
Name string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString