App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services resources.
App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.
For more information about App Runner, see the App Runner Developer Guide. For release information, see the App Runner Release Notes.
To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.
Endpoints
For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apprunner x-aws-signingName: apprunner x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apprunner-2020-05-15.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apprunner.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS App Runner multi-region endpoint - url: https://apprunner.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS App Runner multi-region endpoint - url: http://apprunner.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS App Runner endpoint for China (Beijing) and China (Ningxia) - url: https://apprunner.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS App Runner endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=AppRunner.UpdateService' paths: /#X-Amz-Target=AppRunner.UpdateService: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateService description:Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.
To update the tags applied to your service, use the separate actions TagResource and UntagResource.
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.
true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.
ObservabilityConfigurationArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: 'The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
The port that your application listens to in the container.
Default: 8080
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 Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services 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 Amazon Web Services Systems Manager Parameter Store parameter is not supported.
The current state of the App Runner service. These particular values mean the following.
CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.
The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.
DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.
Describes an App Runner service. It can describe a service in any state, including deleted services.
This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this information is returned by the ListServices action using the ServiceSummary type.
NullableBoolean: type: boolean RuntimeEnvironmentVariables: type: object additionalProperties: $ref: '#/components/schemas/RuntimeEnvironmentVariablesValue' ImageIdentifier: type: string pattern: ([0-9]{12}.dkr.ecr.[a-z\-]+-[0-9]{1}.amazonaws.com\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\w\d+\-=._:\/@])+|@([\w\d\:]+))?)|(^public\.ecr\.aws\/.+\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\w\d+\-=._:\/@])+|@([\w\d\:]+))?) minLength: 1 maxLength: 1024 HealthCheckTimeout: type: integer minimum: 1 maximum: 20 CodeRepository: type: object required: - RepositoryUrl - SourceCodeVersion properties: RepositoryUrl: allOf: - $ref: '#/components/schemas/String' - description: The location of the repository that contains the source code. SourceCodeVersion: allOf: - $ref: '#/components/schemas/SourceCodeVersion' - description: The version that should be used within the source code repository. CodeConfiguration: allOf: - $ref: '#/components/schemas/CodeConfiguration' - description:Configuration for building and running the service from a source code repository.
CodeConfiguration is required only for CreateService request.
The type of version identifier.
For a git-based repository, branches represent versions.
Value: allOf: - $ref: '#/components/schemas/String' - description:A source code version.
For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.
description: Identifies a version of code that App Runner refers to within a source code repository. EncryptionConfiguration: type: object required: - KmsKey properties: KmsKey: allOf: - $ref: '#/components/schemas/KmsKeyArn' - description: The ARN of the KMS key that's used for encryption. description: Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs. UpdateServiceResponse: type: object required: - Service - OperationId properties: Service: allOf: - $ref: '#/components/schemas/Service' - description: A description of the App Runner service updated by this request. All configuration values in the returnedService structure reflect configuration changes that are being applied by this request.
OperationId:
allOf:
- $ref: '#/components/schemas/UUID'
- description: The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.
IngressConfiguration:
type: object
properties:
IsPubliclyAccessible:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False. '
description: Network configuration settings for inbound network traffic.
HealthCheckConfiguration:
type: object
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/HealthCheckProtocol'
- description: 'The IP protocol that App Runner uses to perform health checks for your service.
If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.
Default: TCP
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
The time interval, in seconds, between health checks.
Default: 5
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5
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.
apprunner.yaml file in the source code repository (or ignoring the file if it exists).
description: Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.
InstanceConfiguration:
type: object
properties:
Cpu:
allOf:
- $ref: '#/components/schemas/Cpu'
- description: 'The number of CPU units reserved for each instance of your App Runner service.
Default: 1 vCPU
The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
Default: 2 GB
"Status": "ACTIVE") with the same AutoScalingConfigurationName.'
description: Provides summary information about an App Runner automatic scaling configuration resource.
This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration details. It's returned by the ListAutoScalingConfigurations action. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration, and DeleteAutoScalingConfiguration actions using the AutoScalingConfiguration type.
EgressType: type: string enum: - DEFAULT - VPC SourceConfiguration: type: object properties: CodeRepository: allOf: - $ref: '#/components/schemas/CodeRepository' - description:The description of a source code repository.
You must provide either this member or ImageRepository (but not both).
The description of a source image repository.
You must provide either this member or CodeRepository (but not both).
If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source code commit or new image version) starts a deployment.
Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that''s in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).
The port that your application listens to in the container.
Default: 8080
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 Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services 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 Amazon Web Services Systems Manager Parameter Store parameter is not supported.
apprunner.yaml file in the source code repository.
RuntimeEnvironmentSecrets:
type: object
additionalProperties:
$ref: '#/components/schemas/RuntimeEnvironmentSecretsValue'
RuntimeEnvironmentVariablesValue:
type: string
pattern: .*
minLength: 0
maxLength: 51200
format: password
HealthCheckPath:
type: string
minLength: 1
StartCommand:
type: string
pattern: '[^\x0a\x0d]+'
format: password
ImageRepositoryType:
type: string
enum:
- ECR
- ECR_PUBLIC
Memory:
type: string
pattern: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB
minLength: 3
maxLength: 6
InvalidRequestException: {}
ImageRepository:
type: object
required:
- ImageIdentifier
- ImageRepositoryType
properties:
ImageIdentifier:
allOf:
- $ref: '#/components/schemas/ImageIdentifier'
- description: The identifier of an image.
For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.
ImageConfiguration: allOf: - $ref: '#/components/schemas/ImageConfiguration' - description: Configuration for running the identified image. ImageRepositoryType: allOf: - $ref: '#/components/schemas/ImageRepositoryType' - description: The type of the image repository. This reflects the repository provider and whether the repository is private or public. description: Describes a source image repository. Integer: type: integer EgressConfiguration: type: object properties: EgressType: allOf: - $ref: '#/components/schemas/EgressType' - description:The type of egress configuration.
Set to DEFAULT for access to resources hosted on public networks.
Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
EgressType = VPC.
description: Describes configuration settings related to outbound network traffic of an App Runner service.
Timestamp:
type: string
format: date-time
ResourceNotFoundException: {}
Cpu:
type: string
pattern: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU
minLength: 3
maxLength: 9
SourceCodeVersionType:
type: string
enum:
- BRANCH
HealthCheckProtocol:
type: string
enum:
- TCP
- HTTP
UpdateServiceRequest:
type: object
required:
- ServiceArn
title: UpdateServiceRequest
properties:
ServiceArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of the App Runner service that you want to update.
SourceConfiguration:
allOf:
- $ref: '#/components/schemas/SourceConfiguration'
- description: The source configuration to apply to the App Runner service.
You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way around. This means that you must provide the same structure member of SourceConfiguration that you originally included when you created the service. Specifically, you can include either CodeRepository or ImageRepository. To update the source configuration, set the values to members of the structure that you include.